Create a collection
Creates a new collection in a database.
Ready to write code? See the examples for this method to get started. If you are new to the Data API, check out the quickstart. |
Result
-
Python
-
TypeScript
-
Java
-
curl
Creates a collection with the specified parameters.
Returns a Collection
object.
You can use this object to work with documents in the collection.
Unless you specify the document_type
parameter, the collection is typed as Collection[dict]
.
For more information, see Typing support.
Creates a collection with the specified parameters.
Returns a promise that resolves to a Collection
object.
You can use this object to work with documents in the collection.
A Collection
is typed as Collection<Schema>
, where Schema
defaults to SomeDoc
(Record<string, any>
).
Providing the specific Schema
type enables stronger typing for collection operations.
For more information, see Typing collections and tables.
Creates a collection with the specified parameters.
Returns a Collection
object.
You can use this object to work with documents in the collection.
Creates a collection with the specified parameters.
If the command succeeds, the response indicates the success.
Example successful response:
{
"status": {
"ok": 1
}
}
Parameters
You cannot edit a collection’s definition after you create the collection. |
-
Python
-
TypeScript
-
Java
-
curl
The signature of this method changed in Python client version 2.0. If you are using an earlier version, DataStax recommends upgrading to the latest version. For more information, see Data API client upgrade guide. |
Use the create_collection
method, which belongs to the astrapy.Database
class.
Method signature
create_collection(
name: str,
*,
definition: CollectionDefinition | dict[str, Any] | None,
document_type: type[Any],
keyspace: str,
collection_admin_timeout_ms: int,
spawn_api_options: APIOptions,
) -> Collection
Most astrapy
objects have an asynchronous counterpart for use within the asyncio
framework.
To get an AsyncCollection
, use the create_collection
method of instances of AsyncDatabase
, or use the to_async
method of the synchronous Collection
class.
For more information, see AsyncCollection.
Name | Type | Summary |
---|---|---|
|
|
The name of the new collection. Collection names must follow these rules:
|
|
Optional.
The full configuration for the collection.
See Properties of |
|
|
|
Optional.
A formal specifier for the type checker.
If provided, Default: |
|
|
Optional if you specified a keyspace when instantiating the Default: The working keyspace for the database. |
|
|
Optional.
A timeout, in milliseconds, to impose on the underlying API request.
If not provided, the corresponding |
|
Optional.
A complete or partial specification of the APIOptions to override the defaults inherited from the |
Name | Type | Summary |
---|---|---|
|
Optional. The vector configuration for the collection. This includes things like the vector dimension and similarity metric. Required for vector search. See Create a collection that can store vector embeddings for usage. |
|
|
|
Optional. The selective indexing configuration for the collection. You must use See Create a collection and specify which fields to index and Create a collection and specify which fields shouldn’t be indexed for usage. Default: All fields of all documents. |
|
Optional.
Specifies the default ID type for documents in the collection.
This is used when you insert a document without an Can be one of:
See Create a collection and specify the default ID format for usage. For more information, see Document IDs. Default: |
Use the createCollection
method, which belongs to the Db
class.
Method signature
async createCollection<Schema extends SomeDoc = SomeDoc>(
name: string,
options?: {
vector?: CollectionVectorOptions,
indexing?: CollectionIndexingOptions<Schema>,
defaultId?: CollectionDefaultIdOptions,
logging?: DataAPILoggingConfig,
keyspace?: string,
serdes?: CollectionSerDesConfig,
timeoutDefaults?: TimeoutDescriptor,
timeout?: number | TimeoutDescriptor,
}
): Collection<Schema>
Name | Type | Summary |
---|---|---|
|
|
The name of the new collection. Collection names must follow these rules:
|
|
Optional.
The options for this operation. See Properties of |
Name | Type | Summary |
---|---|---|
Optional. The vector configuration for the collection. This includes things like the vector dimension and similarity metric. Required for vector search. See Create a collection that can store vector embeddings for usage. |
||
Optional. The selective indexing configuration for the collection. You must use See Create a collection and specify which fields to index and Create a collection and specify which fields shouldn’t be indexed for usage. Default: All fields of all documents. |
||
Optional.
Specifies the default ID type for documents in the collection.
This is used when you insert a document without an Can be one of:
See Create a collection and specify the default ID format for usage. For more information, see Document IDs. Default: Each autogenerated |
||
|
Optional if you specified a keyspace when instantiating the Default: The working keyspace for the database. |
|
|
Optional. The configuration for logging events emitted by the DataAPIClient. |
|
|
Optional. The configuration for serialization/deserialization by the DataAPIClient. For more information, see Custom Ser/Des. |
|
|
Optional. The default timeout(s) to apply to operations performed on this Collection instance.
You can specify Details about the
|
|
|
|
Optional. The timeout to apply to this method. Only Default: 60 seconds, unless you specified a different default along the Options Hierarchy. |
Use the createCollection
method, which belongs to the com.datastax.astra.client.Database
class.
Method signature
Collection<Document> createCollection(String collectionName)
Collection<Document> createCollection(
String collectionName,
CollectionDefinition collectionDefinition
)
Collection<Document> createCollection(
String collectionName,
CollectionDefinition collectionDefinition,
CreateCollectionOptions options
)
<T> Collection<T> createCollection(
String collectionName,
Class<T> documentClass
)
<T> Collection<T> createCollection(
String collectionName,
CollectionDefinition collectionDefinition,
Class<T> documentClass
)
<T> Collection<T> createCollection(
String collectionName,
CollectionDefinition collectionDefinition,
Class<T> documentClass,
CreateCollectionOptions options
)
Name | Type | Summary |
---|---|---|
|
|
The name of the new collection. Collection names must follow these rules:
|
|
Settings for the collection, including vector options, the default ID format, and indexing options. |
|
|
Options for the operation, including the keyspace. You must use |
|
|
|
Work with specialized beans for the collection instead of the default |
Use the createCollection
command.
Command signature
curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"createCollection": {
"name": "COLLECTION_NAME",
"options": OPTIONS
}
}'
Name | Type | Summary |
---|---|---|
|
|
The name of the new collection. Collection names must follow these rules:
|
|
|
Optional.
The options for this operation. See Properties of |
Name | Type | Summary |
---|---|---|
|
|
Optional.
Specifies the default ID type for documents in the collection.
This is used when you insert a document without an Can be one of:
See Create a collection and specify the default ID format for usage. For more information, see Document IDs. Default: Each autogenerated |
|
|
Optional. The vector configuration for the collection. This includes things like the vector dimension and similarity metric. Required for vector search. The
See Create a collection that can store vector embeddings for usage. |
|
|
Optional. Configures selective indexing for data inserted to the collection. The
You must use See Create a collection and specify which fields to index and Create a collection and specify which fields shouldn’t be indexed for usage. Default: All fields of all documents. |
Examples
The following examples demonstrate how to create a collection.
Create a collection that is not vector-enabled
-
Python
-
TypeScript
-
Java
-
curl
from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
# Get a database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
# Create a collection
collection = database.create_collection(
"COLLECTION_NAME", keyspace="KEYSPACE_NAME"
)
-
Typed collections
-
Untyped collections
You can manually define a client-side type for your collection to help statically catch errors.
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});
// Define the type for the collection
interface User {
name: string;
age?: number;
}
// Create a collection
(async function () {
const collection = await database.createCollection<User>(
"COLLECTION_NAME",
{
keyspace: "KEYSPACE_NAME",
},
);
})();
If you don’t pass a type parameter, the collection remains untyped. This is a more flexible but less type-safe option.
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});
// Create a collection
(async function () {
const collection = await database.createCollection("COLLECTION_NAME", {
keyspace: "KEYSPACE_NAME",
});
})();
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.definition.CollectionDefinition;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.databases.Database;
public class Example {
public static void main(String[] args) {
// Get a database
DataAPIClient client = DataAPIClients.clientHCD("USERNAME", "PASSWORD");
Database database = client.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
// Create a collection
Collection<Document> collection =
database.createCollection("COLLECTION_NAME", new CollectionDefinition());
}
}
curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"createCollection": {
"name": "COLLECTION_NAME",
"options": {}
}
}'
Create a collection that can store vector embeddings
Collections that are vector-enabled can store vector embeddings in the reserved $vector
field and work with vector search.
-
Python
-
TypeScript
-
Java
-
curl
The Python client supports multiple ways to create a collection:
-
You can define the collection parameters in a
CollectionDefinition
object and then create the collection from theCollectionDefinition
object. -
You can use a fluent interface to build the collection definition and then create the collection from the definition.
-
CollectionDefinition object
-
Fluent interface
from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
from astrapy.constants import VectorMetric
from astrapy.info import CollectionDefinition, CollectionVectorOptions
# Get an existing database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
# Create a collection
collection_definition = CollectionDefinition(
vector=CollectionVectorOptions(
dimension=1024,
metric=VectorMetric.COSINE,
),
)
collection = database.create_collection(
"COLLECTION_NAME",
keyspace="KEYSPACE_NAME",
definition=collection_definition,
)
from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
from astrapy.info import CollectionDefinition
from astrapy.constants import VectorMetric
# Get an existing database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
collection_definition = (
CollectionDefinition.builder()
.set_vector_dimension(1024)
.set_vector_metric(VectorMetric.COSINE)
.build()
)
collection = database.create_collection(
"COLLECTION_NAME",
keyspace="KEYSPACE_NAME",
definition=collection_definition,
)
-
Typed collections
-
Untyped collections
You can manually define a client-side type for your collection to help statically catch errors.
You can define $vector
as an inline field in your interfaces, or you can extend the utility VectorDoc
type provided by the client.
import {
DataAPIClient,
VectorDoc,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});
// Define the type for the collection
interface User extends VectorDoc {
name: string;
age?: number;
}
(async function () {
const collection = await database.createCollection<User>(
"COLLECTION_NAME",
{
vector: {
dimension: 1024,
metric: "cosine",
},
keyspace: "KEYSPACE_NAME",
},
);
})();
If you don’t pass a type parameter, the collection remains untyped. This is a more flexible but less type-safe option.
The $vector
field must still be number[]
or DataAPIVector
, or type-related issues will occur.
Consider using a type like VectorDoc & SomeDoc
which allows the documents to remain untyped, but still statically requires the $vector
field to have the correct type.
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});
(async function () {
const collection = await database.createCollection("COLLECTION_NAME", {
vector: {
dimension: 1024,
metric: "cosine",
},
keyspace: "KEYSPACE_NAME",
});
})();
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.definition.CollectionDefinition;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.vector.SimilarityMetric;
import com.datastax.astra.client.databases.Database;
public class Example {
public static void main(String[] args) {
// Get a database
DataAPIClient client = DataAPIClients.clientHCD("USERNAME", "PASSWORD");
Database database = client.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
// Create a collection
CollectionDefinition collectionDefinition =
new CollectionDefinition().vectorDimension(1024).vectorSimilarity(SimilarityMetric.COSINE);
Collection<Document> collection =
database.createCollection("COLLECTION_NAME", collectionDefinition);
}
}
curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"createCollection": {
"name": "COLLECTION_NAME",
"options": {
"vector": {
"dimension": 1024,
"metric": "cosine"
}
}
}
}'
Create a collection and specify the default ID format
For more information about the default ID format, see Document IDs. For allowed values, see the Parameters.
-
Python
-
TypeScript
-
Java
-
curl
The Python client supports multiple ways to create a collection:
-
You can define the collection parameters in a
CollectionDefinition
object and then create the collection from theCollectionDefinition
object. -
You can use a fluent interface to build the collection definition and then create the collection from the definition.
-
CollectionDefinition object
-
Fluent interface
from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
from astrapy.info import (
CollectionDefinition,
CollectionDefaultIDOptions,
)
from astrapy.constants import DefaultIdType
# Get an existing database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
# Create a collection
collection_definition = CollectionDefinition(
default_id=CollectionDefaultIDOptions(DefaultIdType.OBJECTID),
)
collection = database.create_collection(
"COLLECTION_NAME",
keyspace="KEYSPACE_NAME",
definition=collection_definition,
)
from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
from astrapy.info import CollectionDefinition
from astrapy.constants import DefaultIdType
# Get an existing database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
# Create a collection
collection_definition = (
CollectionDefinition.builder().set_default_id(DefaultIdType.OBJECTID).build()
)
collection = database.create_collection(
"COLLECTION_NAME",
keyspace="KEYSPACE_NAME",
definition=collection_definition,
)
-
Typed collections
-
Untyped collections
You can manually define a client-side type for your collection to help statically catch errors.
The _id
field type should match the defaultId
type.
import {
DataAPIClient,
ObjectId,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});
// Define the type for the collection
interface User {
_id: ObjectId;
name: string;
age?: number;
}
(async function () {
const collection = await database.createCollection<User>(
"COLLECTION_NAME",
{
defaultId: {
type: "objectId",
},
keyspace: "KEYSPACE_NAME",
},
);
})();
If you don’t pass a type parameter, the collection remains untyped. This is a more flexible but less type-safe option.
However, if you later specify _id
when you insert a document, DataStax recommends that it has the same type as the defaultId
.
Consider using a type like { id: ObjectId } & SomeDoc
which allows the documents to remain untyped, but still statically requires the _id
field to have the correct type.
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});
(async function () {
const collection = await database.createCollection("COLLECTION_NAME", {
defaultId: {
type: "objectId",
},
keyspace: "KEYSPACE_NAME",
});
})();
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.definition.CollectionDefaultIdTypes;
import com.datastax.astra.client.collections.definition.CollectionDefinition;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.databases.Database;
public class Example {
public static void main(String[] args) {
// Get a database
DataAPIClient client = DataAPIClients.clientHCD("USERNAME", "PASSWORD");
Database database = client.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
// Create a collection
CollectionDefinition collectionDefinition =
new CollectionDefinition().defaultId(CollectionDefaultIdTypes.OBJECT_ID);
Collection<Document> collection =
database.createCollection("COLLECTION_NAME", collectionDefinition);
}
}
curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"createCollection": {
"name": "COLLECTION_NAME",
"options": {
"defaultId": {
"type": "uuidv7"
}
}
}
}'
Create a collection and specify which fields to index
For more information about selective indexing, see Indexes in collections.
-
Python
-
TypeScript
-
Java
-
curl
The Python client supports multiple ways to create a collection:
-
You can define the collection parameters in a
CollectionDefinition
object and then create the collection from theCollectionDefinition
object. -
You can use a fluent interface to build the collection definition and then create the collection from the definition.
-
CollectionDefinition object
-
Fluent interface
from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
from astrapy.info import CollectionDefinition
# Get an existing database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
# Create a collection
collection_definition = CollectionDefinition(
indexing={"allow": ["city", "country"]},
)
collection = database.create_collection(
"COLLECTION_NAME",
keyspace="KEYSPACE_NAME",
definition=collection_definition,
)
from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
from astrapy.info import CollectionDefinition
# Get an existing database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
# Create a collection
collection_definition = (
CollectionDefinition.builder().set_indexing("allow", ["city", "country"]).build()
)
collection = database.create_collection(
"COLLECTION_NAME",
keyspace="KEYSPACE_NAME",
definition=collection_definition,
)
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});
(async function () {
const collection = await database.createCollection("COLLECTION_NAME", {
indexing: {
allow: ["city", "country"],
},
keyspace: "KEYSPACE_NAME",
});
})();
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.definition.CollectionDefinition;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.databases.Database;
public class Example {
public static void main(String[] args) {
// Get a database
DataAPIClient client = DataAPIClients.clientHCD("USERNAME", "PASSWORD");
Database database = client.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
// Create a collection
CollectionDefinition collectionDefinition =
new CollectionDefinition().indexingAllow("city", "country");
Collection<Document> collection =
database.createCollection("COLLECTION_NAME", collectionDefinition);
}
}
curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"createCollection": {
"name": "COLLECTION_NAME",
"options": {
"indexing": {
"allow": ["city", "country"]
}
}
}
}'
Create a collection and specify which fields shouldn’t be indexed
For more information about selective indexing, see Indexes in collections.
-
Python
-
TypeScript
-
Java
-
curl
The Python client supports multiple ways to create a collection:
-
You can define the collection parameters in a
CollectionDefinition
object and then create the collection from theCollectionDefinition
object. -
You can use a fluent interface to build the collection definition and then create the collection from the definition.
-
CollectionDefinition object
-
Fluent interface
from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
from astrapy.info import CollectionDefinition
# Get an existing database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
# Create a collection
collection_definition = CollectionDefinition(
indexing={"deny": ["city", "country"]},
)
collection = database.create_collection(
"COLLECTION_NAME",
keyspace="KEYSPACE_NAME",
definition=collection_definition,
)
from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment
from astrapy.info import CollectionDefinition
# Get an existing database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
"API_ENDPOINT",
token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
# Create a collection
collection_definition = (
CollectionDefinition.builder().set_indexing("deny", ["city", "country"]).build()
)
collection = database.create_collection(
"COLLECTION_NAME",
keyspace="KEYSPACE_NAME",
definition=collection_definition,
)
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});
(async function () {
const collection = await database.createCollection("COLLECTION_NAME", {
indexing: {
deny: ["city", "country"],
},
keyspace: "KEYSPACE_NAME",
});
})();
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.definition.CollectionDefinition;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.databases.Database;
public class Example {
public static void main(String[] args) {
// Get a database
DataAPIClient client = DataAPIClients.clientHCD("USERNAME", "PASSWORD");
Database database = client.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
// Create a collection
CollectionDefinition collectionDefinition =
new CollectionDefinition().indexingDeny("city", "country");
Collection<Document> collection =
database.createCollection("COLLECTION_NAME", collectionDefinition);
}
}
curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
"createCollection": {
"name": "COLLECTION_NAME",
"options": {
"indexing": {
"deny": ["city", "country"]
}
}
}
}'
Client reference
-
Python
-
TypeScript
-
Java
-
curl
For more information, see the client reference.
For more information, see the client reference.
For more information, see the client reference.
Client reference documentation is not applicable for HTTP.