Package com.ibm.cloud.cloudant.v1.model

Class PutDatabaseOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.cloudant.v1.model.PutDatabaseOptions

All Implemented Interfaces:

ObjectModel

public class PutDatabaseOptions
extends GenericModel

The putDatabase options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PutDatabaseOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
String	db()	Gets the db.
PutDatabaseOptions.Builder	newBuilder()	New builder.
Boolean	partitioned()	Gets the partitioned.
Long	q()	Gets the q.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public PutDatabaseOptions.Builder newBuilder()

New builder.

Returns:

a PutDatabaseOptions builder

db

public String db()

Gets the db. Path parameter to specify the database name.

Returns:

the db

partitioned

public Boolean partitioned()

Gets the partitioned. Query parameter to specify whether to enable database partitions when creating a database. Before using read the [FAQs](https://cloud.ibm.com/docs/Cloudant?topic=Cloudant-database-partitioning#partitioned-databases-database-partitioning) to understand the limitations and appropriate use cases.

Returns:

the partitioned

q

public Long q()

Gets the q. 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.

Returns:

the q