id
stringlengths
7
77
text
stringlengths
0
3.4k
metadata
dict
astrapy.core.db.AstraDB.caller_version
{ "kind": "attribute", "name": "caller_version", "path": "astrapy.core.db.AstraDB.caller_version", "parameters": null, "returns": null, "gathered_types": null, "value": "caller_version = caller_version", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "exam...
astrapy.core.db.AstraDB.token
{ "kind": "attribute", "name": "token", "path": "astrapy.core.db.AstraDB.token", "parameters": null, "returns": null, "gathered_types": null, "value": "token = token", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "references": null, ...
astrapy.core.db.AstraDB.api_endpoint
{ "kind": "attribute", "name": "api_endpoint", "path": "astrapy.core.db.AstraDB.api_endpoint", "parameters": null, "returns": null, "gathered_types": null, "value": "api_endpoint = api_endpoint", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": nu...
astrapy.core.db.AstraDB.base_url
{ "kind": "attribute", "name": "base_url", "path": "astrapy.core.db.AstraDB.base_url", "parameters": null, "returns": null, "gathered_types": null, "value": "base_url = self.api_endpoint.strip('/')", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example"...
astrapy.core.db.AstraDB.api_path
{ "kind": "attribute", "name": "api_path", "path": "astrapy.core.db.AstraDB.api_path", "parameters": null, "returns": null, "gathered_types": [ "astrapy.core.defaults.DEFAULT_JSON_API_PATH" ], "value": "api_path = DEFAULT_JSON_API_PATH if api_path is None else api_path.strip('/')", "yields": null,...
astrapy.core.db.AstraDB.api_version
{ "kind": "attribute", "name": "api_version", "path": "astrapy.core.db.AstraDB.api_version", "parameters": null, "returns": null, "gathered_types": [ "astrapy.core.defaults.DEFAULT_JSON_API_VERSION" ], "value": "api_version = DEFAULT_JSON_API_VERSION if api_version is None else api_version.strip('/'...
astrapy.core.db.AstraDB.namespace
{ "kind": "attribute", "name": "namespace", "path": "astrapy.core.db.AstraDB.namespace", "parameters": null, "returns": null, "gathered_types": null, "value": "namespace = namespace", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "refer...
astrapy.core.db.AstraDB.base_path
{ "kind": "attribute", "name": "base_path", "path": "astrapy.core.db.AstraDB.base_path", "parameters": null, "returns": null, "gathered_types": null, "value": "base_path: str = f'/{'/'.join(base_path_components)}'", "yields": null, "imports": null, "properties": null, "bases": null, "exports": n...
astrapy.core.db.AstraDB.copy
{ "kind": "function", "name": "copy", "path": "astrapy.core.db.AstraDB.copy", "parameters": [ { "name": "token", "type": "str | None", "description": null, "default": "None", "value": null }, { "name": "api_endpoint", "type": "str | None", "description...
astrapy.core.db.AstraDB.to_async
{ "kind": "function", "name": "to_async", "path": "astrapy.core.db.AstraDB.to_async", "parameters": null, "returns": [ { "name": null, "type": "AsyncAstraDB", "description": null } ], "gathered_types": [ "astrapy.core.db.AsyncAstraDB" ], "value": null, "yields": null, ...
astrapy.core.db.AstraDB.set_caller
{ "kind": "function", "name": "set_caller", "path": "astrapy.core.db.AstraDB.set_caller", "parameters": [ { "name": "caller_name", "type": "str | None", "description": null, "default": "None", "value": null }, { "name": "caller_version", "type": "str | None"...
astrapy.core.db.AstraDB.post_raw_request
{ "kind": "function", "name": "post_raw_request", "path": "astrapy.core.db.AstraDB.post_raw_request", "parameters": [ { "name": "body", "type": "dict[str, Any]", "description": null, "default": null, "value": null }, { "name": "timeout_info", "type": "Timeou...
astrapy.core.db.AstraDB.collection
Retrieve a collection from the database.
{ "kind": "function", "name": "collection", "path": "astrapy.core.db.AstraDB.collection", "parameters": [ { "name": "collection_name", "type": "str", "description": "The name of the collection to retrieve.", "default": null, "value": null } ], "returns": [ { "...
astrapy.core.db.AstraDB.get_collections
Retrieve a list of collections from the database.
{ "kind": "function", "name": "get_collections", "path": "astrapy.core.db.AstraDB.get_collections", "parameters": [ { "name": "options", "type": "dict", "description": "Options to get the collection list", "default": "None", "value": "None" }, { "name": "timeout_i...
astrapy.core.db.AstraDB.create_collection
Create a new collection in the database.
{ "kind": "function", "name": "create_collection", "path": "astrapy.core.db.AstraDB.create_collection", "parameters": [ { "name": "collection_name", "type": "str", "description": "The name of the collection to create.", "default": null, "value": null }, { "name": ...
astrapy.core.db.AstraDB.delete_collection
Delete a collection from the database.
{ "kind": "function", "name": "delete_collection", "path": "astrapy.core.db.AstraDB.delete_collection", "parameters": [ { "name": "collection_name", "type": "str", "description": "The name of the collection to delete.", "default": null, "value": null }, { "name": ...
astrapy.core.db.AsyncAstraDB
{ "kind": "class", "name": "AsyncAstraDB", "path": "astrapy.core.db.AsyncAstraDB", "parameters": [ { "name": "token", "type": "str | None", "description": null, "default": null, "value": null }, { "name": "api_endpoint", "type": "str", "description": n...
astrapy.core.db.AsyncAstraDB.caller_name
{ "kind": "attribute", "name": "caller_name", "path": "astrapy.core.db.AsyncAstraDB.caller_name", "parameters": null, "returns": null, "gathered_types": null, "value": "caller_name = caller_name", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": n...
astrapy.core.db.AsyncAstraDB.caller_version
{ "kind": "attribute", "name": "caller_version", "path": "astrapy.core.db.AsyncAstraDB.caller_version", "parameters": null, "returns": null, "gathered_types": null, "value": "caller_version = caller_version", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, ...
astrapy.core.db.AsyncAstraDB.client
{ "kind": "attribute", "name": "client", "path": "astrapy.core.db.AsyncAstraDB.client", "parameters": null, "returns": null, "gathered_types": [ "AsyncClient" ], "value": "client = httpx.AsyncClient()", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, ...
astrapy.core.db.AsyncAstraDB.token
{ "kind": "attribute", "name": "token", "path": "astrapy.core.db.AsyncAstraDB.token", "parameters": null, "returns": null, "gathered_types": null, "value": "token = token", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "references": nul...
astrapy.core.db.AsyncAstraDB.api_endpoint
{ "kind": "attribute", "name": "api_endpoint", "path": "astrapy.core.db.AsyncAstraDB.api_endpoint", "parameters": null, "returns": null, "gathered_types": null, "value": "api_endpoint = api_endpoint", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example...
astrapy.core.db.AsyncAstraDB.base_url
{ "kind": "attribute", "name": "base_url", "path": "astrapy.core.db.AsyncAstraDB.base_url", "parameters": null, "returns": null, "gathered_types": null, "value": "base_url = self.api_endpoint.strip('/')", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "exa...
astrapy.core.db.AsyncAstraDB.api_path
{ "kind": "attribute", "name": "api_path", "path": "astrapy.core.db.AsyncAstraDB.api_path", "parameters": null, "returns": null, "gathered_types": [ "astrapy.core.defaults.DEFAULT_JSON_API_PATH" ], "value": "api_path = DEFAULT_JSON_API_PATH if api_path is None else api_path.strip('/')", "yields": ...
astrapy.core.db.AsyncAstraDB.api_version
{ "kind": "attribute", "name": "api_version", "path": "astrapy.core.db.AsyncAstraDB.api_version", "parameters": null, "returns": null, "gathered_types": [ "astrapy.core.defaults.DEFAULT_JSON_API_VERSION" ], "value": "api_version = DEFAULT_JSON_API_VERSION if api_version is None else api_version.stri...
astrapy.core.db.AsyncAstraDB.namespace
{ "kind": "attribute", "name": "namespace", "path": "astrapy.core.db.AsyncAstraDB.namespace", "parameters": null, "returns": null, "gathered_types": null, "value": "namespace = namespace", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "...
astrapy.core.db.AsyncAstraDB.base_path
{ "kind": "attribute", "name": "base_path", "path": "astrapy.core.db.AsyncAstraDB.base_path", "parameters": null, "returns": null, "gathered_types": null, "value": "base_path: str = f'/{'/'.join(base_path_components)}'", "yields": null, "imports": null, "properties": null, "bases": null, "export...
astrapy.core.db.AsyncAstraDB.copy
{ "kind": "function", "name": "copy", "path": "astrapy.core.db.AsyncAstraDB.copy", "parameters": [ { "name": "token", "type": "str | None", "description": null, "default": "None", "value": null }, { "name": "api_endpoint", "type": "str | None", "descri...
astrapy.core.db.AsyncAstraDB.to_sync
{ "kind": "function", "name": "to_sync", "path": "astrapy.core.db.AsyncAstraDB.to_sync", "parameters": null, "returns": [ { "name": null, "type": "AstraDB", "description": null } ], "gathered_types": [ "astrapy.core.db.AstraDB" ], "value": null, "yields": null, "impor...
astrapy.core.db.AsyncAstraDB.set_caller
{ "kind": "function", "name": "set_caller", "path": "astrapy.core.db.AsyncAstraDB.set_caller", "parameters": [ { "name": "caller_name", "type": "str | None", "description": null, "default": "None", "value": null }, { "name": "caller_version", "type": "str | ...
astrapy.core.db.AsyncAstraDB.post_raw_request
{ "kind": "function", "name": "post_raw_request", "path": "astrapy.core.db.AsyncAstraDB.post_raw_request", "parameters": [ { "name": "body", "type": "dict[str, Any]", "description": null, "default": null, "value": null }, { "name": "timeout_info", "type": "T...
astrapy.core.db.AsyncAstraDB.collection
Retrieve a collection from the database.
{ "kind": "function", "name": "collection", "path": "astrapy.core.db.AsyncAstraDB.collection", "parameters": [ { "name": "collection_name", "type": "str", "description": "The name of the collection to retrieve.", "default": null, "value": null }, { "name": "timeou...
astrapy.core.db.AsyncAstraDB.get_collections
Retrieve a list of collections from the database.
{ "kind": "function", "name": "get_collections", "path": "astrapy.core.db.AsyncAstraDB.get_collections", "parameters": [ { "name": "options", "type": "dict", "description": "Options to get the collection list", "default": "None", "value": "None" }, { "name": "time...
astrapy.core.db.AsyncAstraDB.create_collection
Create a new collection in the database.
{ "kind": "function", "name": "create_collection", "path": "astrapy.core.db.AsyncAstraDB.create_collection", "parameters": [ { "name": "collection_name", "type": "str", "description": "The name of the collection to create.", "default": null, "value": null }, { "na...
astrapy.core.db.AsyncAstraDB.delete_collection
Delete a collection from the database.
{ "kind": "function", "name": "delete_collection", "path": "astrapy.core.db.AsyncAstraDB.delete_collection", "parameters": [ { "name": "collection_name", "type": "str", "description": "The name of the collection to delete.", "default": null, "value": null }, { "na...
astrapy.core.api
{ "kind": "module", "name": "api", "path": "astrapy.core.api", "parameters": null, "returns": null, "gathered_types": null, "value": null, "yields": null, "imports": { "annotations": "__future__.annotations", "logging": "logging", "Any": "typing.Any", "cast": "typing.cast", "httpx"...
astrapy.core.api.logger
{ "kind": "attribute", "name": "logger", "path": "astrapy.core.api.logger", "parameters": null, "returns": null, "gathered_types": [ "__name__" ], "value": "logger = logging.getLogger(__name__)", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "exampl...
astrapy.core.api.APIRequestError
{ "kind": "class", "name": "APIRequestError", "path": "astrapy.core.api.APIRequestError", "parameters": [ { "name": "response", "type": "httpx.Response", "description": null, "default": null, "value": null }, { "name": "payload", "type": "dict[str, Any] | No...
astrapy.core.api.APIRequestError.response
{ "kind": "attribute", "name": "response", "path": "astrapy.core.api.APIRequestError.response", "parameters": null, "returns": null, "gathered_types": null, "value": "response = response", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "...
astrapy.core.api.APIRequestError.payload
{ "kind": "attribute", "name": "payload", "path": "astrapy.core.api.APIRequestError.payload", "parameters": null, "returns": null, "gathered_types": null, "value": "payload = payload", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "refe...
astrapy.core.api.raw_api_request
{ "kind": "function", "name": "raw_api_request", "path": "astrapy.core.api.raw_api_request", "parameters": [ { "name": "client", "type": "httpx.Client", "description": null, "default": null, "value": null }, { "name": "base_url", "type": "str", "descri...
astrapy.core.api.process_raw_api_response
{ "kind": "function", "name": "process_raw_api_response", "path": "astrapy.core.api.process_raw_api_response", "parameters": [ { "name": "raw_response", "type": "httpx.Response", "description": null, "default": null, "value": null }, { "name": "skip_error_check", ...
astrapy.core.api.api_request
{ "kind": "function", "name": "api_request", "path": "astrapy.core.api.api_request", "parameters": [ { "name": "client", "type": "httpx.Client", "description": null, "default": null, "value": null }, { "name": "base_url", "type": "str", "description": ...
astrapy.core.api.async_raw_api_request
{ "kind": "function", "name": "async_raw_api_request", "path": "astrapy.core.api.async_raw_api_request", "parameters": [ { "name": "client", "type": "httpx.AsyncClient", "description": null, "default": null, "value": null }, { "name": "base_url", "type": "st...
astrapy.core.api.async_process_raw_api_response
{ "kind": "function", "name": "async_process_raw_api_response", "path": "astrapy.core.api.async_process_raw_api_response", "parameters": [ { "name": "raw_response", "type": "httpx.Response", "description": null, "default": null, "value": null }, { "name": "skip_er...
astrapy.core.api.async_api_request
{ "kind": "function", "name": "async_api_request", "path": "astrapy.core.api.async_api_request", "parameters": [ { "name": "client", "type": "httpx.AsyncClient", "description": null, "default": null, "value": null }, { "name": "base_url", "type": "str", ...
astrapy.core.ops
{ "kind": "module", "name": "ops", "path": "astrapy.core.ops", "parameters": null, "returns": null, "gathered_types": null, "value": null, "yields": null, "imports": { "annotations": "__future__.annotations", "logging": "logging", "Any": "typing.Any", "cast": "typing.cast", "httpx"...
astrapy.core.ops.logger
{ "kind": "attribute", "name": "logger", "path": "astrapy.core.ops.logger", "parameters": null, "returns": null, "gathered_types": [ "__name__" ], "value": "logger = logging.getLogger(__name__)", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "exampl...
astrapy.core.ops.AstraDBOpsConstructorParams
{ "kind": "class", "name": "AstraDBOpsConstructorParams", "path": "astrapy.core.ops.AstraDBOpsConstructorParams", "parameters": null, "returns": null, "gathered_types": null, "value": null, "yields": null, "imports": null, "properties": null, "bases": [ "TypedDict" ], "exports": null, "e...
astrapy.core.ops.AstraDBOpsConstructorParams.token
{ "kind": "attribute", "name": "token", "path": "astrapy.core.ops.AstraDBOpsConstructorParams.token", "parameters": null, "returns": null, "gathered_types": null, "value": "token: str | None", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null,...
astrapy.core.ops.AstraDBOpsConstructorParams.dev_ops_url
{ "kind": "attribute", "name": "dev_ops_url", "path": "astrapy.core.ops.AstraDBOpsConstructorParams.dev_ops_url", "parameters": null, "returns": null, "gathered_types": null, "value": "dev_ops_url: str | None", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, ...
astrapy.core.ops.AstraDBOpsConstructorParams.dev_ops_api_version
{ "kind": "attribute", "name": "dev_ops_api_version", "path": "astrapy.core.ops.AstraDBOpsConstructorParams.dev_ops_api_version", "parameters": null, "returns": null, "gathered_types": null, "value": "dev_ops_api_version: str | None", "yields": null, "imports": null, "properties": null, "bases": n...
astrapy.core.ops.AstraDBOpsConstructorParams.caller_name
{ "kind": "attribute", "name": "caller_name", "path": "astrapy.core.ops.AstraDBOpsConstructorParams.caller_name", "parameters": null, "returns": null, "gathered_types": null, "value": "caller_name: str | None", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, ...
astrapy.core.ops.AstraDBOpsConstructorParams.caller_version
{ "kind": "attribute", "name": "caller_version", "path": "astrapy.core.ops.AstraDBOpsConstructorParams.caller_version", "parameters": null, "returns": null, "gathered_types": null, "value": "caller_version: str | None", "yields": null, "imports": null, "properties": null, "bases": null, "exports...
astrapy.core.ops.AstraDBOps
{ "kind": "class", "name": "AstraDBOps", "path": "astrapy.core.ops.AstraDBOps", "parameters": [ { "name": "token", "type": "str | None", "description": null, "default": null, "value": null }, { "name": "dev_ops_url", "type": "str | None", "description"...
astrapy.core.ops.AstraDBOps.client
{ "kind": "attribute", "name": "client", "path": "astrapy.core.ops.AstraDBOps.client", "parameters": null, "returns": null, "gathered_types": [ "Client" ], "value": "client = httpx.Client()", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": ...
astrapy.core.ops.AstraDBOps.async_client
{ "kind": "attribute", "name": "async_client", "path": "astrapy.core.ops.AstraDBOps.async_client", "parameters": null, "returns": null, "gathered_types": [ "AsyncClient" ], "value": "async_client = httpx.AsyncClient()", "yields": null, "imports": null, "properties": null, "bases": null, "e...
astrapy.core.ops.AstraDBOps.caller_name
{ "kind": "attribute", "name": "caller_name", "path": "astrapy.core.ops.AstraDBOps.caller_name", "parameters": null, "returns": null, "gathered_types": null, "value": "caller_name = caller_name", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": nu...
astrapy.core.ops.AstraDBOps.caller_version
{ "kind": "attribute", "name": "caller_version", "path": "astrapy.core.ops.AstraDBOps.caller_version", "parameters": null, "returns": null, "gathered_types": null, "value": "caller_version = caller_version", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "...
astrapy.core.ops.AstraDBOps.constructor_params
{ "kind": "attribute", "name": "constructor_params", "path": "astrapy.core.ops.AstraDBOps.constructor_params", "parameters": null, "returns": null, "gathered_types": [ "AstraDBOpsConstructorParams" ], "value": "constructor_params: AstraDBOpsConstructorParams = {'token': token, 'dev_ops_url': dev_ops...
astrapy.core.ops.AstraDBOps.token
{ "kind": "attribute", "name": "token", "path": "astrapy.core.ops.AstraDBOps.token", "parameters": null, "returns": null, "gathered_types": null, "value": "token: str | None", "yields": null, "imports": null, "properties": null, "bases": null, "exports": null, "example": null, "references": ...
astrapy.core.ops.AstraDBOps.base_url
{ "kind": "attribute", "name": "base_url", "path": "astrapy.core.ops.AstraDBOps.base_url", "parameters": null, "returns": null, "gathered_types": null, "value": "base_url = f'{dev_ops_url}/{dev_ops_api_version}'", "yields": null, "imports": null, "properties": null, "bases": null, "exports": nul...
astrapy.core.ops.AstraDBOps.copy
{ "kind": "function", "name": "copy", "path": "astrapy.core.ops.AstraDBOps.copy", "parameters": [ { "name": "token", "type": "str | None", "description": null, "default": "None", "value": null }, { "name": "dev_ops_url", "type": "str | None", "descript...
astrapy.core.ops.AstraDBOps.set_caller
{ "kind": "function", "name": "set_caller", "path": "astrapy.core.ops.AstraDBOps.set_caller", "parameters": [ { "name": "caller_name", "type": "str | None", "description": null, "default": "None", "value": null }, { "name": "caller_version", "type": "str | N...
astrapy.core.ops.AstraDBOps.get_databases
Retrieve a list of databases.
{ "kind": "function", "name": "get_databases", "path": "astrapy.core.ops.AstraDBOps.get_databases", "parameters": [ { "name": "options", "type": "dict", "description": "Additional options for the request.", "default": "None", "value": "None" } ], "returns": [ { ...
astrapy.core.ops.AstraDBOps.async_get_databases
Retrieve a list of databases - async version of the method.
{ "kind": "function", "name": "async_get_databases", "path": "astrapy.core.ops.AstraDBOps.async_get_databases", "parameters": [ { "name": "options", "type": "dict", "description": "Additional options for the request.", "default": "None", "value": "None" } ], "returns": ...
astrapy.core.ops.AstraDBOps.create_database
Create a new database.
{ "kind": "function", "name": "create_database", "path": "astrapy.core.ops.AstraDBOps.create_database", "parameters": [ { "name": "database_definition", "type": "dict", "description": "A dictionary defining the properties of the database to be created.", "default": "None", "val...
astrapy.core.ops.AstraDBOps.async_create_database
Create a new database - async version of the method.
{ "kind": "function", "name": "async_create_database", "path": "astrapy.core.ops.AstraDBOps.async_create_database", "parameters": [ { "name": "database_definition", "type": "dict", "description": "A dictionary defining the properties of the database to be created.", "default": "None"...
astrapy.core.ops.AstraDBOps.terminate_database
Terminate an existing database.
{ "kind": "function", "name": "terminate_database", "path": "astrapy.core.ops.AstraDBOps.terminate_database", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database to terminate.", "default": "''", "value": "''" }, { "n...
astrapy.core.ops.AstraDBOps.async_terminate_database
Terminate an existing database - async version of the method.
{ "kind": "function", "name": "async_terminate_database", "path": "astrapy.core.ops.AstraDBOps.async_terminate_database", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database to terminate.", "default": "''", "value": "''" }, ...
astrapy.core.ops.AstraDBOps.get_database
Retrieve details of a specific database.
{ "kind": "function", "name": "get_database", "path": "astrapy.core.ops.AstraDBOps.get_database", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database to retrieve.", "default": "''", "value": "''" }, { "name": "option...
astrapy.core.ops.AstraDBOps.async_get_database
Retrieve details of a specific database - async version of the method.
{ "kind": "function", "name": "async_get_database", "path": "astrapy.core.ops.AstraDBOps.async_get_database", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database to retrieve.", "default": "''", "value": "''" }, { "na...
astrapy.core.ops.AstraDBOps.create_keyspace
Create a keyspace in a specified database.
{ "kind": "function", "name": "create_keyspace", "path": "astrapy.core.ops.AstraDBOps.create_keyspace", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database where the keyspace will be created.", "default": "''", "value": "''" }...
astrapy.core.ops.AstraDBOps.async_create_keyspace
Create a keyspace in a specified database - async version of the method.
{ "kind": "function", "name": "async_create_keyspace", "path": "astrapy.core.ops.AstraDBOps.async_create_keyspace", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database where the keyspace will be created.", "default": "''", "value"...
astrapy.core.ops.AstraDBOps.delete_keyspace
Delete a keyspace from a database
{ "kind": "function", "name": "delete_keyspace", "path": "astrapy.core.ops.AstraDBOps.delete_keyspace", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database to terminate.", "default": "''", "value": "''" }, { "name": ...
astrapy.core.ops.AstraDBOps.async_delete_keyspace
Delete a keyspace from a database - async version of the method.
{ "kind": "function", "name": "async_delete_keyspace", "path": "astrapy.core.ops.AstraDBOps.async_delete_keyspace", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database to terminate.", "default": "''", "value": "''" }, { ...
astrapy.core.ops.AstraDBOps.park_database
Park a specific database, making it inactive.
{ "kind": "function", "name": "park_database", "path": "astrapy.core.ops.AstraDBOps.park_database", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database to park.", "default": "''", "value": "''" } ], "returns": [ { ...
astrapy.core.ops.AstraDBOps.unpark_database
Unpark a specific database, making it active again.
{ "kind": "function", "name": "unpark_database", "path": "astrapy.core.ops.AstraDBOps.unpark_database", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database to unpark.", "default": "''", "value": "''" } ], "returns": [ ...
astrapy.core.ops.AstraDBOps.resize_database
Resize a specific database according to provided options.
{ "kind": "function", "name": "resize_database", "path": "astrapy.core.ops.AstraDBOps.resize_database", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database to resize.", "default": "''", "value": "''" }, { "name": "op...
astrapy.core.ops.AstraDBOps.reset_database_password
Reset the password for a specific database.
{ "kind": "function", "name": "reset_database_password", "path": "astrapy.core.ops.AstraDBOps.reset_database_password", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database for which to reset the password.", "default": "''", "value...
astrapy.core.ops.AstraDBOps.get_secure_bundle
Retrieve a secure bundle URL for a specific database.
{ "kind": "function", "name": "get_secure_bundle", "path": "astrapy.core.ops.AstraDBOps.get_secure_bundle", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database for which to get the secure bundle.", "default": "''", "value": "''" ...
astrapy.core.ops.AstraDBOps.get_datacenters
Get a list of datacenters associated with a specific database.
{ "kind": "function", "name": "get_datacenters", "path": "astrapy.core.ops.AstraDBOps.get_datacenters", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database for which to list datacenters.", "default": "''", "value": "''" } ],...
astrapy.core.ops.AstraDBOps.create_datacenter
Create a new datacenter for a specific database.
{ "kind": "function", "name": "create_datacenter", "path": "astrapy.core.ops.AstraDBOps.create_datacenter", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database for which to create the datacenter.", "default": "''", "value": "''" ...
astrapy.core.ops.AstraDBOps.terminate_datacenter
Terminate a specific datacenter in a database.
{ "kind": "function", "name": "terminate_datacenter", "path": "astrapy.core.ops.AstraDBOps.terminate_datacenter", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database containing the datacenter.", "default": "''", "value": "''" ...
astrapy.core.ops.AstraDBOps.get_access_list
Retrieve the access list for a specific database.
{ "kind": "function", "name": "get_access_list", "path": "astrapy.core.ops.AstraDBOps.get_access_list", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database for which to get the access list.", "default": "''", "value": "''" } ...
astrapy.core.ops.AstraDBOps.replace_access_list
Replace the entire access list for a specific database.
{ "kind": "function", "name": "replace_access_list", "path": "astrapy.core.ops.AstraDBOps.replace_access_list", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database for which to replace the access list.", "default": "''", "value": ...
astrapy.core.ops.AstraDBOps.update_access_list
Update the access list for a specific database.
{ "kind": "function", "name": "update_access_list", "path": "astrapy.core.ops.AstraDBOps.update_access_list", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database for which to update the access list.", "default": "''", "value": "''...
astrapy.core.ops.AstraDBOps.add_access_list_address
Add a new address to the access list for a specific database.
{ "kind": "function", "name": "add_access_list_address", "path": "astrapy.core.ops.AstraDBOps.add_access_list_address", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database for which to add the address.", "default": "''", "value": ...
astrapy.core.ops.AstraDBOps.delete_access_list
Delete the access list for a specific database.
{ "kind": "function", "name": "delete_access_list", "path": "astrapy.core.ops.AstraDBOps.delete_access_list", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database for which to delete the access list.", "default": "''", "value": "''...
astrapy.core.ops.AstraDBOps.get_private_link
Retrieve the private link information for a specified database.
{ "kind": "function", "name": "get_private_link", "path": "astrapy.core.ops.AstraDBOps.get_private_link", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database.", "default": "''", "value": "''" } ], "returns": [ { ...
astrapy.core.ops.AstraDBOps.get_datacenter_private_link
Retrieve the private link information for a specific datacenter in a database.
{ "kind": "function", "name": "get_datacenter_private_link", "path": "astrapy.core.ops.AstraDBOps.get_datacenter_private_link", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database.", "default": "''", "value": "''" }, { ...
astrapy.core.ops.AstraDBOps.create_datacenter_private_link
Create a private link for a specific datacenter in a database.
{ "kind": "function", "name": "create_datacenter_private_link", "path": "astrapy.core.ops.AstraDBOps.create_datacenter_private_link", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database.", "default": "''", "value": "''" }, ...
astrapy.core.ops.AstraDBOps.create_datacenter_endpoint
Create an endpoint for a specific datacenter in a database.
{ "kind": "function", "name": "create_datacenter_endpoint", "path": "astrapy.core.ops.AstraDBOps.create_datacenter_endpoint", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database.", "default": "''", "value": "''" }, { ...
astrapy.core.ops.AstraDBOps.update_datacenter_endpoint
Update an existing endpoint for a specific datacenter in a database.
{ "kind": "function", "name": "update_datacenter_endpoint", "path": "astrapy.core.ops.AstraDBOps.update_datacenter_endpoint", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database.", "default": "''", "value": "''" }, { ...
astrapy.core.ops.AstraDBOps.get_datacenter_endpoint
Retrieve information about a specific endpoint in a datacenter of a database.
{ "kind": "function", "name": "get_datacenter_endpoint", "path": "astrapy.core.ops.AstraDBOps.get_datacenter_endpoint", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database.", "default": "''", "value": "''" }, { "name...
astrapy.core.ops.AstraDBOps.delete_datacenter_endpoint
Delete a specific endpoint in a datacenter of a database.
{ "kind": "function", "name": "delete_datacenter_endpoint", "path": "astrapy.core.ops.AstraDBOps.delete_datacenter_endpoint", "parameters": [ { "name": "database", "type": "str", "description": "The identifier of the database.", "default": "''", "value": "''" }, { ...
astrapy.core.ops.AstraDBOps.get_available_classic_regions
Retrieve a list of available classic regions.
{ "kind": "function", "name": "get_available_classic_regions", "path": "astrapy.core.ops.AstraDBOps.get_available_classic_regions", "parameters": [ { "name": "timeout_info", "type": "TimeoutInfoWideType", "description": null, "default": "None", "value": null } ], "retur...
astrapy.core.ops.AstraDBOps.get_available_regions
Retrieve a list of available regions for serverless deployment.
{ "kind": "function", "name": "get_available_regions", "path": "astrapy.core.ops.AstraDBOps.get_available_regions", "parameters": [ { "name": "timeout_info", "type": "TimeoutInfoWideType", "description": null, "default": "None", "value": null } ], "returns": [ { ...
astrapy.core.ops.AstraDBOps.get_roles
Retrieve a list of roles within the organization.
{ "kind": "function", "name": "get_roles", "path": "astrapy.core.ops.AstraDBOps.get_roles", "parameters": [ { "name": "timeout_info", "type": "TimeoutInfoWideType", "description": null, "default": "None", "value": null } ], "returns": [ { "name": "dict", ...
astrapy.core.ops.AstraDBOps.create_role
Create a new role within the organization.
{ "kind": "function", "name": "create_role", "path": "astrapy.core.ops.AstraDBOps.create_role", "parameters": [ { "name": "role_definition", "type": "dict", "description": "The definition of the role to be created.", "default": "None", "value": "None" } ], "returns": [ ...