couchdb-database-info

couchdb-database-info

Stability Level

, unless otherwise indicated

Synopsis

#define             COUCHDB_TYPE_DATABASE_INFO
GType               couchdb_database_info_get_type      (void);
CouchdbDatabaseInfo * couchdb_database_info_ref         (CouchdbDatabaseInfo *dbinfo);
void                couchdb_database_info_unref         (CouchdbDatabaseInfo *dbinfo);
const char *        couchdb_database_info_get_dbname    (CouchdbDatabaseInfo *dbinfo);
gint                couchdb_database_info_get_documents_count
                                                        (CouchdbDatabaseInfo *dbinfo);
gint                couchdb_database_info_get_deleted_documents_count
                                                        (CouchdbDatabaseInfo *dbinfo);
gint                couchdb_database_info_get_update_sequence
                                                        (CouchdbDatabaseInfo *dbinfo);
gboolean            couchdb_database_info_is_compact_running
                                                        (CouchdbDatabaseInfo *dbinfo);
gint                couchdb_database_info_get_disk_size (CouchdbDatabaseInfo *dbinfo);
CouchdbDatabaseInfo* couchdb_database_info_new          (const char *dbname,
                                                         gint doc_count,
                                                         gint doc_del_count,
                                                         gint update_seq,
                                                         gboolean compact_running,
                                                         gint disk_size);

Description

Details

COUCHDB_TYPE_DATABASE_INFO

#define             COUCHDB_TYPE_DATABASE_INFO


couchdb_database_info_get_type ()

GType               couchdb_database_info_get_type      (void);

Returns :


couchdb_database_info_ref ()

CouchdbDatabaseInfo * couchdb_database_info_ref         (CouchdbDatabaseInfo *dbinfo);

Increments reference counting of the given CouchdbDatabaseInfo object.

dbinfo :

Returns :

A pointer to the object being referenced.

couchdb_database_info_unref ()

void                couchdb_database_info_unref         (CouchdbDatabaseInfo *dbinfo);

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

dbinfo :


couchdb_database_info_get_dbname ()

const char *        couchdb_database_info_get_dbname    (CouchdbDatabaseInfo *dbinfo);

Get the database name stored in the CouchdbDatabaseInfo object.

dbinfo :

A CouchdbDatabaseInfo object

Returns :

Name of the database.

couchdb_database_info_get_documents_count ()

gint                couchdb_database_info_get_documents_count
                                                        (CouchdbDatabaseInfo *dbinfo);

Get the number of documents stored in the CouchdbDatabaseInfo object.

dbinfo :

A CouchdbDatabaseInfo object

Returns :

Number of documents in the database.

couchdb_database_info_get_deleted_documents_count ()

gint                couchdb_database_info_get_deleted_documents_count
                                                        (CouchdbDatabaseInfo *dbinfo);

Get the number of deleted documents stored in the CouchdbDatabaseInfo object.

dbinfo :

A CouchdbDatabaseInfo object

Returns :

Number of deleted documents.

couchdb_database_info_get_update_sequence ()

gint                couchdb_database_info_get_update_sequence
                                                        (CouchdbDatabaseInfo *dbinfo);

Get the last update sequence stored in the CouchdbDatabaseInfo object. This sequence is incremented with each change done to the database.

dbinfo :

A CouchdbDatabaseInfo object

Returns :

Last update sequence.

couchdb_database_info_is_compact_running ()

gboolean            couchdb_database_info_is_compact_running
                                                        (CouchdbDatabaseInfo *dbinfo);

Get whether compacting is running on the database at the time the information was retrieved.

dbinfo :

A CouchdbDatabaseInfo object

Returns :

Whether compacting is running or not.

couchdb_database_info_get_disk_size ()

gint                couchdb_database_info_get_disk_size (CouchdbDatabaseInfo *dbinfo);

Get the size of database on disk stored in the CouchdbDatabaseInfo object.

dbinfo :

A CouchdbDatabaseInfo object

Returns :

Size of the database on disk.

couchdb_database_info_new ()

CouchdbDatabaseInfo* couchdb_database_info_new          (const char *dbname,
                                                         gint doc_count,
                                                         gint doc_del_count,
                                                         gint update_seq,
                                                         gboolean compact_running,
                                                         gint disk_size);

Create a new CouchdbDatabaseInfo object, which is used to store information (name, number of documents, etc) of a database in CouchDB.

dbname :

Database name

doc_count :

Number of documents in the database

doc_del_count :

Number of deleted documents in the database

update_seq :

Last update sequence

compact_running :

Whether compacting is in progress

disk_size :

Size of database on disk

Returns :

A newly-created CouchdbDatabaseInfo object.