com.cloudant.client.api.model

Class DbInfo

java.lang.Object

com.cloudant.client.api.model.DbInfo

public class DbInfo
extends java.lang.Object

Encapsulates information about a database instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbInfo.PartitionedIndexes Encapsulates partitioned index properties.
static class	DbInfo.Props Encapsulates database properties.
static class	DbInfo.Sizes

Constructor Summary

Constructors

Constructor and Description
DbInfo()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDbName()
int	getDiskFormatVersion()
long	getDiskSize()
long	getDocCount()
java.lang.String	getDocDelCount() Deprecated.
long	getDocDelCountLong()
long	getInstanceStartTime()
DbInfo.PartitionedIndexes	getPartitionedIndexes() Get the DbInfo.PartitionedIndexes object for this database.
DbInfo.Props	getProps() Get the database properties.
long	getPurgeSeq() Deprecated.
DbInfo.Sizes	getSizes()
java.lang.String	getStringPurgeSeq() An opaque string that describes the state of purge operations across the database.
java.lang.String	getUpdateSeq()
boolean	isCompactRunning()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DbInfo

public DbInfo()

Method Detail

getDbName

public java.lang.String getDbName()

getDocCount

public long getDocCount()

getDocDelCount

@Deprecated
public java.lang.String getDocDelCount()

Deprecated.

Returns:

string form of the number of deleted documents in the database

See Also:

getDocDelCountLong()

getDocDelCountLong

public long getDocDelCountLong()

Returns:

number of deleted documents in the database

getUpdateSeq

public java.lang.String getUpdateSeq()

getPurgeSeq

@Deprecated
public long getPurgeSeq()

Deprecated.

Use getStringPurgeSeq() instead. The value 0 is returned if the purged_seq field cannot be cast as a primitive long. In later versions of CouchDB (>=2.3.x) purged_seq is an opaque string.

Returns:

Number of purge operations on the database.

getStringPurgeSeq

public java.lang.String getStringPurgeSeq()

An opaque string that describes the state of purge operations across the database.

Returns:

Purge sequence.

isCompactRunning

public boolean isCompactRunning()

getDiskSize

public long getDiskSize()

getInstanceStartTime

public long getInstanceStartTime()

getDiskFormatVersion

public int getDiskFormatVersion()

getProps

public DbInfo.Props getProps()

Get the database properties.

Returns:

database properties

getPartitionedIndexes

public DbInfo.PartitionedIndexes getPartitionedIndexes()

Get the DbInfo.PartitionedIndexes object for this database.

Returns:

The DbInfo.PartitionedIndexes object, containing metadata about partitioned indexes in this database.

getSizes

public DbInfo.Sizes getSizes()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object