Qodex.ai
Qodex.ai
Introduction
Astra DB DevOps
Tokens
Get TokensCreate TokenDelete Token
Roles
List RolesGet RoleCreate RoleUpdate RoleDelete Role
Users
List UsersGet UserDelete UserInvite Users
Databases
List DatabasesCreate Database
(Deprecated) Create Auth TokenList Available RegionsList Available Serverless RegionsGet Current Org
Data API vector collection
Create and find collections
findCollections
Insert data
insertMany documents with $vectorinsertMany documents with $vectorize
Find data
find with pagingState: to get all purchases showing Page 2 resultsfind sorted by $vectorize search, projection enabled, return similarity scores
Find and modify data
findOneAndDelete with $vectorize
Update data
updateMany - Set element value
Delete data
deleteMany - delete by statusdeleteCollection - delete by collection name, vectorize
Data API vector collection non-astra
Create namespaces
createNamespace
Create and find collections
findCollections
Insert data
insertMany documents with $vectorinsertMany documents with $vectorize
Find data
find with pagingState: to get all purchases showing Page 2 resultsfind sorted by $vectorize search, projection enabled, return similarity scores
Find and modify data
findOneAndDelete with $vectorize
Update data
updateMany - Set element value
Delete data
deleteMany - delete by statusdeleteCollection - delete by collection name, vectorize
Stargate Document API reference
v2-namespaces/{namespace-id}/collections-{collection-id}-{document-id}-{document-path}
Get a sub document by {document-path}Replace a sub document by {document-path}Update part of a sub document by {document-path}Delete a sub document by {document-path}
v2-namespaces/{namespace-id}/collections-{collection-id}-{document-id}
Get a document by {document-id}Replace a document by {document-id}Update part of a documentDelete a document
v2-namespaces/{namespace-id}/collections-{collection-id}
Search for documents in {collection-id}Add a new document to {collection-id}Write multiple new documents in one request
v2-namespaces/{namespace-id}/collections
Create a collectionList collections in a namespace
v2-schemas/namespaces-{namespace-id}-collections/{collection-id}
Get a collectionDelete a collection
v2-schemas/namespaces-{namespace-id}
Get a namespaceDelete a namespace
v2-schemas/namespaces
Create a namespaceGet all namespaces
Create an auth token Copy
Stargate-Document-API:library
init request
Init request
Authentication
Create a auth token (Stargate OSS only)
Create schema
Create a simple namespace test (Stargate OSS only)
Retrieve schema
Get a particular namespace (test)Get all namespaces
Create collection schema
Create empty collection library2Put a JSON SchemaGet a JSON Schema
Get collection info
Get all collections from a namespaceGet a collection's JSON schema
Write data
PUT document with documentIdPOST ONE READERPOST ONE BOOKGet one bookPOST MULTIPLE BOOKS with id-pathPOST ONE READER WITH DOCUMENT-ID
Decorations for writing - TTL and profiling
PUT TTLGET TTL
Write data with document-path
PUT ONE BOOK WITH DOCUMENT-PATHPATCH ONE BOOK WITH DOCUMENT-PATH
Functions
Pop an item off of the genre arrayGet state of the array genre again
Get all docs in a collection
Get all documents in a collection with page-state
Get docs in a collection with WHERE
Get all documents in a collection WHERE book title eq a particular book in reader.reviews
Get an identified document with info
Get a single document with fields
Read data with document-path
Get a path in a particular documentGet an array in a path in a particular document with a document-pathGet an array in a path in a particular document with a document-path
Delete data
Delete collection libraryDelete a doc-path from a documentDelete collection library2Delete document with WHEREDelete document from collection
Delete schema
Delete namespaces test (Stargate OSS only)
Stargate-Document-API:myworld
authentication
Create a auth token (Stargate OSS only)
create schema
Create a namespace myworld with RF (Stargate OSS only)
retrieve schema
Get all namespacesGet namespaces myworld
insert data
POST nonsense-stuffPUT JanetPUT MarthaPUT JoeyPATCH JoeyPATCH Joey weights (nested)PATCH Janet
retrieve data
Get document WHERE firstname EQ Janet/Joey/Martha/JanetLee OR weights.type="bench press" or "squat"Get document JoeyGet document Joey, the weights valueGet document Joey, the weights type value
delete data
Delete the document Janet
delete schema
Delete namespaces myworld (Stargate OSS only)
Stargate-GraphQL-API:library
init request
Init request
authentication
Create a auth token (Stargate OSS only)
schema
Alter table book, add columns isbn, language, pub_year, and genre
retrieve schema
Get tables
insert data
Update a book again - Moby Dick with genre
retrieve data
Read (get) reader with UDT
delete data
Delete one book with CL
delete schema
Drop keyspace (Stargate OSS only)
Stargate-REST-API:users_keyspace
init request
Init request
authenticate
Create a auth token (Stargate OSS only)
create schema
Create a keyspace with replica set to 1 (Stargate OSS only)Create a user-defined type (UDT) called addressCreate a table usersCreate a column address (UDT)Change the column firstname to firstChange the column first back to firstnameChange the table definition back againCreate table index country_idx (TUPLE)
retrieve schema
Get a listing of keyspacesGet info for users_keyspaceGet a listing of all tables with defined columnsGet a listing of all columns in table usersGet column email infoGet table indexesGet UDTs
insert data
Insert Janesha DoeshaPatch user: Mookie Betts with email valuePut user: Mookie Betts evaluation update
retrieve data
Get row using partition key onlyGet record for user using primary key in pathGet row with WHERE clause (EQ, CONTAINS, CONTAINSKEY, CONTAINSENTRY) for collections, tuples, UDTs
delete data
Delete record of user: Mookie Betts
delete schema
Delete column emailDrop table index fav_books_idxDelete table usersDelete UDT address_typeDelete keyspace users_keyspace (Stargate OSS only)
Stargate: Leveraging Stargate Document API as a TimeSeries DB
Report 1: Weekly temperature report by day for a Boston for Week 26Report 2: Weekly temperature comparison for 2 Boston & Seattle for Week 26
Introduction
Astra DB DevOps
Tokens
Get TokensCreate TokenDelete Token
Roles
List RolesGet RoleCreate RoleUpdate RoleDelete Role
Users
List UsersGet UserDelete UserInvite Users
Databases
List DatabasesCreate Database
(Deprecated) Create Auth TokenList Available RegionsList Available Serverless RegionsGet Current Org
Data API vector collection
Create and find collections
findCollections
Insert data
insertMany documents with $vectorinsertMany documents with $vectorize
Find data
find with pagingState: to get all purchases showing Page 2 resultsfind sorted by $vectorize search, projection enabled, return similarity scores
Find and modify data
findOneAndDelete with $vectorize
Update data
updateMany - Set element value
Delete data
deleteMany - delete by statusdeleteCollection - delete by collection name, vectorize
Data API vector collection non-astra
Create namespaces
createNamespace
Create and find collections
findCollections
Insert data
insertMany documents with $vectorinsertMany documents with $vectorize
Find data
find with pagingState: to get all purchases showing Page 2 resultsfind sorted by $vectorize search, projection enabled, return similarity scores
Find and modify data
findOneAndDelete with $vectorize
Update data
updateMany - Set element value
Delete data
deleteMany - delete by statusdeleteCollection - delete by collection name, vectorize
Stargate Document API reference
v2-namespaces/{namespace-id}/collections-{collection-id}-{document-id}-{document-path}
Get a sub document by {document-path}Replace a sub document by {document-path}Update part of a sub document by {document-path}Delete a sub document by {document-path}
v2-namespaces/{namespace-id}/collections-{collection-id}-{document-id}
Get a document by {document-id}Replace a document by {document-id}Update part of a documentDelete a document
v2-namespaces/{namespace-id}/collections-{collection-id}
Search for documents in {collection-id}Add a new document to {collection-id}Write multiple new documents in one request
v2-namespaces/{namespace-id}/collections
Create a collectionList collections in a namespace
v2-schemas/namespaces-{namespace-id}-collections/{collection-id}
Get a collectionDelete a collection
v2-schemas/namespaces-{namespace-id}
Get a namespaceDelete a namespace
v2-schemas/namespaces
Create a namespaceGet all namespaces
Create an auth token Copy
Stargate-Document-API:library
init request
Init request
Authentication
Create a auth token (Stargate OSS only)
Create schema
Create a simple namespace test (Stargate OSS only)
Retrieve schema
Get a particular namespace (test)Get all namespaces
Create collection schema
Create empty collection library2Put a JSON SchemaGet a JSON Schema
Get collection info
Get all collections from a namespaceGet a collection's JSON schema
Write data
PUT document with documentIdPOST ONE READERPOST ONE BOOKGet one bookPOST MULTIPLE BOOKS with id-pathPOST ONE READER WITH DOCUMENT-ID
Decorations for writing - TTL and profiling
PUT TTLGET TTL
Write data with document-path
PUT ONE BOOK WITH DOCUMENT-PATHPATCH ONE BOOK WITH DOCUMENT-PATH
Functions
Pop an item off of the genre arrayGet state of the array genre again
Get all docs in a collection
Get all documents in a collection with page-state
Get docs in a collection with WHERE
Get all documents in a collection WHERE book title eq a particular book in reader.reviews
Get an identified document with info
Get a single document with fields
Read data with document-path
Get a path in a particular documentGet an array in a path in a particular document with a document-pathGet an array in a path in a particular document with a document-path
Delete data
Delete collection libraryDelete a doc-path from a documentDelete collection library2Delete document with WHEREDelete document from collection
Delete schema
Delete namespaces test (Stargate OSS only)
Stargate-Document-API:myworld
authentication
Create a auth token (Stargate OSS only)
create schema
Create a namespace myworld with RF (Stargate OSS only)
retrieve schema
Get all namespacesGet namespaces myworld
insert data
POST nonsense-stuffPUT JanetPUT MarthaPUT JoeyPATCH JoeyPATCH Joey weights (nested)PATCH Janet
retrieve data
Get document WHERE firstname EQ Janet/Joey/Martha/JanetLee OR weights.type="bench press" or "squat"Get document JoeyGet document Joey, the weights valueGet document Joey, the weights type value
delete data
Delete the document Janet
delete schema
Delete namespaces myworld (Stargate OSS only)
Stargate-GraphQL-API:library
init request
Init request
authentication
Create a auth token (Stargate OSS only)
schema
Alter table book, add columns isbn, language, pub_year, and genre
retrieve schema
Get tables
insert data
Update a book again - Moby Dick with genre
retrieve data
Read (get) reader with UDT
delete data
Delete one book with CL
delete schema
Drop keyspace (Stargate OSS only)
Stargate-REST-API:users_keyspace
init request
Init request
authenticate
Create a auth token (Stargate OSS only)
create schema
Create a keyspace with replica set to 1 (Stargate OSS only)Create a user-defined type (UDT) called addressCreate a table usersCreate a column address (UDT)Change the column firstname to firstChange the column first back to firstnameChange the table definition back againCreate table index country_idx (TUPLE)
retrieve schema
Get a listing of keyspacesGet info for users_keyspaceGet a listing of all tables with defined columnsGet a listing of all columns in table usersGet column email infoGet table indexesGet UDTs
insert data
Insert Janesha DoeshaPatch user: Mookie Betts with email valuePut user: Mookie Betts evaluation update
retrieve data
Get row using partition key onlyGet record for user using primary key in pathGet row with WHERE clause (EQ, CONTAINS, CONTAINSKEY, CONTAINSENTRY) for collections, tuples, UDTs
delete data
Delete record of user: Mookie Betts
delete schema
Delete column emailDrop table index fav_books_idxDelete table usersDelete UDT address_typeDelete keyspace users_keyspace (Stargate OSS only)
Stargate: Leveraging Stargate Document API as a TimeSeries DB
Report 1: Weekly temperature report by day for a Boston for Week 26Report 2: Weekly temperature comparison for 2 Boston & Seattle for Week 26
HomeData API vector collection non-astraInsert data

Insert data

Number of APIs: 2

  1. insertMany documents with $vectorize POST {{DB_API_ENDPOINT}}/{{DB_KEYSPACE}}/{{DB_VECTORIZE_COLLECTION}}

  2. insertMany documents with $vector POST {{DB_API_ENDPOINT}}/{{DB_KEYSPACE}}/{{DB_COLLECTION}}

Previous
findCollections
Next
insertMany documents with $vector