Interface PutDatabaseParams

Parameters for the putDatabase operation.

Hierarchy

  • PutDatabaseParams

Properties

db headers? partitioned? q?

Properties

db

db: string

Path parameter to specify the database name.

Optional headers

headers?: OutgoingHttpHeaders

Optional partitioned

partitioned?: boolean

Query parameter to specify whether to enable database partitions when creating a database.

Optional q

q?: number

The number of shards in the database. Each shard is a partition of the hash value range. Cloudant recommends using the default value for most databases. However, if your database is expected to be larger than 250 GB or have a lot of indexes, you may need to adjust the settings. In these cases, it's best to reach out to IBM Cloudant customer support for guidance on how to meet your specific needs and requirements.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc