CouchdbDocument

typedef struct _CouchdbDocument CouchdbDocument;

CouchdbDocumentClass

typedef struct {
	GObjectClass parent_class;
} CouchdbDocumentClass;

couchdb_document_new ()

CouchdbDocument *   couchdb_document_new                (void);

Create an empty CouchdbDocument object, which can then be populated with data and added to a database.

couchdb_document_get_id ()

const char *        couchdb_document_get_id             (CouchdbDocument *document);

Retrieve the unique ID of the given document.

couchdb_document_set_id ()

void                couchdb_document_set_id             (CouchdbDocument *document,
                                                         const char *id);

Set the unique ID for a given document.

This usually is not needed by calling applications, unless they want to force IDs on the CouchDB documents created/updated for some reason, like compatibility with 3rd party applications. In most cases, the autogenerated IDs from CouchDB when new documents are created (see couchdb_document_put) should be ok for most applications.

couchdb_document_get_revision ()

const char *        couchdb_document_get_revision       (CouchdbDocument *document);

Retrieve the revision of a given document.

CouchDB does not overwrite updated documents in place, instead it creates a new document at the end of the database file, with the same ID but a new revision.

Document revisions are used for optimistic concurrency control and applications should not rely on document revisions for any other purpose than concurrency control.

couchdb_document_set_revision ()

void                couchdb_document_set_revision       (CouchdbDocument *document,
                                                         const char *revision);

Set the revision of the given document. This should never be used by applications, unless they really know what they are doing, since using a wrong revision string will confuse CouchDB when doing updates to the document.

couchdb_document_has_field ()

gboolean            couchdb_document_has_field          (CouchdbDocument *document,
                                                         const char *field);

Check whether the given document has a field with a specific name.

couchdb_document_remove_field ()

void                couchdb_document_remove_field       (CouchdbDocument *document,
                                                         const char *field);

Remove a field from the given document.

couchdb_document_get_field_names ()

GSList *            couchdb_document_get_field_names    (CouchdbDocument *document);

Retrieve the list of fields contained in the given CouchdbDocument.

couchdb_document_get_field_type ()

GType               couchdb_document_get_field_type     (CouchdbDocument *document,
                                                         const char *field);

Get the value type of the given CouchdbDocument's field.

couchdb_document_get_array_field ()

CouchdbArrayField * couchdb_document_get_array_field    (CouchdbDocument *document,
                                                         const char *field);

Retrieve the value of an array field from the given document.

couchdb_document_set_array_field ()

void                couchdb_document_set_array_field    (CouchdbDocument *document,
                                                         const char *field,
                                                         CouchdbArrayField *value);

Set the value of an array field in the given document.

couchdb_document_get_boolean_field ()

gboolean            couchdb_document_get_boolean_field  (CouchdbDocument *document,
                                                         const char *field);

Retrieve the value of a boolean field from the given document.

couchdb_document_set_boolean_field ()

void                couchdb_document_set_boolean_field  (CouchdbDocument *document,
                                                         const char *field,
                                                         gboolean value);

Set the value of a boolean field in the given document.

couchdb_document_get_int_field ()

gint                couchdb_document_get_int_field      (CouchdbDocument *document,
                                                         const char *field);

Retrieve the value of an integer field from the given document.

couchdb_document_set_int_field ()

void                couchdb_document_set_int_field      (CouchdbDocument *document,
                                                         const char *field,
                                                         gint value);

Set the value of an integer field in the given document.

couchdb_document_get_double_field ()

gdouble             couchdb_document_get_double_field   (CouchdbDocument *document,
                                                         const char *field);

Retrieve the value of a decimal number field from the given document.

couchdb_document_set_double_field ()

void                couchdb_document_set_double_field   (CouchdbDocument *document,
                                                         const char *field,
                                                         gdouble value);

Set the value of a decimal number field in the given document.

couchdb_document_get_string_field ()

const char *        couchdb_document_get_string_field   (CouchdbDocument *document,
                                                         const char *field);

Retrieve the value of a string field from the given document.

couchdb_document_set_string_field ()

void                couchdb_document_set_string_field   (CouchdbDocument *document,
                                                         const char *field,
                                                         const char *value);

Set the value of a string field in the given document.

couchdb_document_get_struct_field ()

CouchdbStructField * couchdb_document_get_struct_field  (CouchdbDocument *document,
                                                         const char *field);

Retrieve the value of a struct field from the given document.

couchdb_document_set_struct_field ()

void                couchdb_document_set_struct_field   (CouchdbDocument *document,
                                                         const char *field,
                                                         CouchdbStructField *value);

Set the value of a struct field in the given document.

couchdb_document_to_string ()

char *              couchdb_document_to_string          (CouchdbDocument *document);

Convert the given CouchdbDocument to a JSON string.

couchdb_document_get_record_type ()

const char *        couchdb_document_get_record_type    (CouchdbDocument *document);

Retrieve the record type of the given document. Record types are special fields in the CouchDB documents, used in Desktopcouch, to identify standard records. All supported record types are listed at http://www.freedesktop.org/wiki/Specifications/desktopcouchFormats.

couchdb_document_set_record_type ()

void                couchdb_document_set_record_type    (CouchdbDocument *document,
                                                         const char *record_type);

Set the record type of the given document.

couchdb_document_get_application_annotations ()

CouchdbStructField * couchdb_document_get_application_annotations
                                                        (CouchdbDocument *document);

Retrieve the application annotations for the given document.

Application annotations is a special field (named "application_annotations"), used in Desktopcouch to allow applications to set values on standard documents (as defined at http://www.freedesktop.org/wiki/Specifications/desktopcouchFormats) that are not part of the standard, but still needed by the application.

couchdb_document_set_application_annotations ()

void                couchdb_document_set_application_annotations
                                                        (CouchdbDocument *document,
                                                         CouchdbStructField *annotations);

Set the application annotations for the given document.

COUCHDB_RECORD_TYPE_CONTACT

#define             COUCHDB_RECORD_TYPE_CONTACT

COUCHDB_RECORD_TYPE_TASK

#define             COUCHDB_RECORD_TYPE_TASK

couchdb_document_is_contact ()

gboolean            couchdb_document_is_contact         (CouchdbDocument *document);

Check whether the given document represents a contact record, as specified at http://www.freedesktop.org/wiki/Specifications/desktopcouch/contact

couchdb_document_is_task ()

gboolean            couchdb_document_is_task            (CouchdbDocument *document);

Check whether the given document represents a contact record, as specified at http://www.freedesktop.org/wiki/Specifications/desktopcouch/task

CouchdbDocumentPrivate

typedef struct _CouchdbDocumentPrivate CouchdbDocumentPrivate;

The "database" property

  "database"                 CouchdbDatabase*      : Read / Write / Construct

Database from which this document was retrieved/saved.