Class PartitionInformation

Schema for information about a database partition.

Index

Constructors

Properties

dbName docCount docDelCount partition partitionedIndexes? sizes

Methods

deserialize serialize

Constructors

constructor

new PartitionInformation(): CloudantV1.PartitionInformation

Returns CloudantV1.PartitionInformation

Properties

dbName

dbName: string

Schema for a database name.

docCount

docCount: number

A count of the documents in the specified database partition.

docDelCount

docDelCount: number

Number of deleted documents.

partition

partition: string

Schema for a partition key.

`Optional`partitionedIndexes

partitionedIndexes?: CloudantV1.PartitionInformationIndexes

Schema for information about the partition index count and limit in a database.

sizes

sizes: CloudantV1.PartitionInformationSizes

The size of active and external data, in bytes.

Methods

`Static`deserialize

deserialize(obj: any): CloudantV1.PartitionInformation
Parameters
- obj: any
Returns CloudantV1.PartitionInformation
- Defined in cloudant/v1.ts:16274

`Static`serialize

serialize(obj: any): CloudantV1.PartitionInformation.Transport
Parameters
- obj: any
Returns CloudantV1.PartitionInformation.Transport
- Defined in cloudant/v1.ts:16248