| Reference Manual for CouchDB GLib Bindings | ||||
|---|---|---|---|---|
| Top | Description | ||||
#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_deleted_documents_count (CouchdbDatabaseInfo *dbinfo); gint couchdb_database_info_get_disk_format_version (CouchdbDatabaseInfo *dbinfo); gint couchdb_database_info_get_disk_size (CouchdbDatabaseInfo *dbinfo); gint couchdb_database_info_get_documents_count (CouchdbDatabaseInfo *dbinfo); gint couchdb_database_info_get_instance_start_time (CouchdbDatabaseInfo *dbinfo); gint couchdb_database_info_get_purge_sequence (CouchdbDatabaseInfo *dbinfo); gint couchdb_database_info_get_update_sequence (CouchdbDatabaseInfo *dbinfo); gboolean couchdb_database_info_is_compact_running (CouchdbDatabaseInfo *dbinfo); CouchdbDatabaseInfo * couchdb_database_info_new (const char *dbname,gint doc_count,gint doc_del_count,gint update_seq,gint purse_seq,gboolean compact_running,gint disk_size,gint disk_format_version,gint instance_start_time);
CouchdbDatabaseInfo * couchdb_database_info_ref (CouchdbDatabaseInfo *dbinfo);
Increments reference counting of the given CouchdbDatabaseInfo object.
Returns : |
A pointer to the object being referenced. |
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.
const char * couchdb_database_info_get_dbname (CouchdbDatabaseInfo *dbinfo);
Get the database name stored in the CouchdbDatabaseInfo object.
|
A CouchdbDatabaseInfo object |
Returns : |
Name of the database. |
gint couchdb_database_info_get_deleted_documents_count
(CouchdbDatabaseInfo *dbinfo);
Get the number of deleted documents stored in the CouchdbDatabaseInfo object.
|
A CouchdbDatabaseInfo object |
Returns : |
Number of deleted documents. |
gint couchdb_database_info_get_disk_format_version
(CouchdbDatabaseInfo *dbinfo);
Get the current version of the internal database format on disk.
|
A CouchdbDatabaseInfo object |
Returns : |
Current version of the internal database format on disk. |
gint couchdb_database_info_get_disk_size (CouchdbDatabaseInfo *dbinfo);
Get the size of database on disk stored in the CouchdbDatabaseInfo object.
|
A CouchdbDatabaseInfo object |
Returns : |
Size of the database on disk. |
gint couchdb_database_info_get_documents_count
(CouchdbDatabaseInfo *dbinfo);
Get the number of documents stored in the CouchdbDatabaseInfo object.
|
A CouchdbDatabaseInfo object |
Returns : |
Number of documents in the database. |
gint couchdb_database_info_get_instance_start_time
(CouchdbDatabaseInfo *dbinfo);
Get the timestamp of CouchDBs start time.
|
A CouchdbDatabaseInfo object |
Returns : |
Timestamp of CouchDBs start time. |
gint couchdb_database_info_get_purge_sequence
(CouchdbDatabaseInfo *dbinfo);
Get the number of purge operations.
|
A CouchdbDatabaseInfo object |
Returns : |
Number of purge operations. |
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.
|
A CouchdbDatabaseInfo object |
Returns : |
Last update sequence. |
gboolean couchdb_database_info_is_compact_running
(CouchdbDatabaseInfo *dbinfo);
Get whether compacting is running on the database at the time the information was retrieved.
|
A CouchdbDatabaseInfo object |
Returns : |
Whether compacting is running or not. |
CouchdbDatabaseInfo * couchdb_database_info_new (const char *dbname,gint doc_count,gint doc_del_count,gint update_seq,gint purse_seq,gboolean compact_running,gint disk_size,gint disk_format_version,gint instance_start_time);
Create a new CouchdbDatabaseInfo object, which is used to store information
(name, number of documents, etc) of a database in CouchDB.
|
Database name |
|
Number of documents in the database |
|
Number of deleted documents in the database |
|
Last update sequence |
|
Whether compacting is in progress |
|
Size of database on disk |
|
Current version of the internal database format on disk |
|
Timestamp of CouchDBs start time |
Returns : |
A newly-created CouchdbDatabaseInfo object. |