couchdb-document-info

couchdb-document-info

Synopsis

#define             COUCHDB_TYPE_DOCUMENT_INFO
GType               couchdb_document_info_get_type      (void);
CouchdbDocumentInfo * couchdb_document_info_new         (const char *docid,
                                                         const char *revision);
CouchdbDocumentInfo * couchdb_document_info_ref         (CouchdbDocumentInfo *dbinfo);
void                couchdb_document_info_unref         (CouchdbDocumentInfo *dbinfo);
const char *        couchdb_document_info_get_docid     (CouchdbDocumentInfo *doc_info);
const char *        couchdb_document_info_get_revision  (CouchdbDocumentInfo *doc_info);

Description

Details

COUCHDB_TYPE_DOCUMENT_INFO

#define COUCHDB_TYPE_DOCUMENT_INFO (couchdb_document_info_get_type ())


couchdb_document_info_get_type ()

GType               couchdb_document_info_get_type      (void);


couchdb_document_info_new ()

CouchdbDocumentInfo * couchdb_document_info_new         (const char *docid,
                                                         const char *revision);

Create a new CouchdbDocumentInfo object, which is used to store information about a document on a CouchDB database. It contains information like the Unique ID and revision of the document.

docid :

Unique ID of the document

revision :

Current revision of the document

Returns :

A newly-created CouchDocumentInfo object.

couchdb_document_info_ref ()

CouchdbDocumentInfo * couchdb_document_info_ref         (CouchdbDocumentInfo *dbinfo);

Increments reference counting of the given CouchdbDocumentInfo object.

Returns :

A pointer to the object being referenced.

couchdb_document_info_unref ()

void                couchdb_document_info_unref         (CouchdbDocumentInfo *dbinfo);

Decrements reference counting of the given CouchdbDocumentInfo object. When the reference count is equal to 0, the object will be destroyed.


couchdb_document_info_get_docid ()

const char *        couchdb_document_info_get_docid     (CouchdbDocumentInfo *doc_info);

Get the unique ID stored in the CouchdbDocumentInfo object.

doc_info :

A CouchdbDocumentInfo object

Returns :

Unique ID.

couchdb_document_info_get_revision ()

const char *        couchdb_document_info_get_revision  (CouchdbDocumentInfo *doc_info);

Get the revision stored in the CouchdbDocumentInfo object.

doc_info :

A CouchdbDocumentInfo object

Returns :

Revision number.