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,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"note": null,
"implemented_by": null,
"attributes": 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": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": 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('/')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"default": "None",
"value": null
},
{
"name": "api_path",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "api_version",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "namespace",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "AstraDB",
"description": null
}
],
"gathered_types": [
"astrapy.core.db.AstraDB"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": 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",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "None",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "API_RESPONSE",
"description": null
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": [
{
"name": "AstraDBCollection",
"type": "AstraDBCollection",
"description": "The collection object."
}
],
"gathered_types": [
"astrapy.core.db.AstraDBCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for the HTTP request.\nNote that a 'read' timeout event will not block the action taken\nby the API server if it has received the request already.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "API_RESPONSE",
"description": "An object containing the list of collections in the database:\n{\"status\": {\"collections\": [...]}}"
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "options",
"type": "dict",
"description": "Options for the collection.",
"default": "None",
"value": "None"
},
{
"name": "dimension",
"type": "int",
"description": "Dimension for vector search.",
"default": "None",
"value": "None"
},
{
"name": "metric",
"type": "str",
"description": "Metric choice for vector search.",
"default": "None",
"value": "None"
},
{
"name": "service_dict",
"type": "dict",
"description": "a definition for the $vectorize service",
"default": "None",
"value": "None"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for the HTTP request.\nNote that a 'read' timeout event will not block the action taken\nby the API server if it has received the request already.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "AstraDBCollection",
"type": "AstraDBCollection",
"description": "The created collection object."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.db.AstraDBCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for the HTTP request.\nNote that a 'read' timeout event will not block the action taken\nby the API server if it has received the request already.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "API_RESPONSE",
"description": "The response from the database."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": null,
"default": null,
"value": null
},
{
"name": "api_path",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "api_version",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "namespace",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": 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,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": 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": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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.strip('/')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"references": null,
"note": null,
"implemented_by": null,
"attributes": 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,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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",
"description": null,
"default": "None",
"value": null
},
{
"name": "api_path",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "api_version",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "namespace",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "AsyncAstraDB",
"description": null
}
],
"gathered_types": [
"astrapy.core.db.AsyncAstraDB"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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 | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "None",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "API_RESPONSE",
"description": null
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": "timeout_info",
"type": null,
"description": "a float, or a TimeoutInfo dict, for the HTTP request.\nNote that a 'read' timeout event will not block the action taken\nby the API server if it has received the request already.",
"default": null,
"value": null
}
],
"returns": [
{
"name": "AstraDBCollection",
"type": "AsyncAstraDBCollection",
"description": "The collection object."
}
],
"gathered_types": [
"astrapy.core.db.AsyncAstraDBCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for the HTTP request.\nNote that a 'read' timeout event will not block the action taken\nby the API server if it has received the request already.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "API_RESPONSE",
"description": "An object containing the list of collections in the database:\n{\"status\": {\"collections\": [...]}}"
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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
},
{
"name": "options",
"type": "dict",
"description": "Options for the collection.",
"default": "None",
"value": "None"
},
{
"name": "dimension",
"type": "int",
"description": "Dimension for vector search.",
"default": "None",
"value": "None"
},
{
"name": "metric",
"type": "str",
"description": "Metric choice for vector search.",
"default": "None",
"value": "None"
},
{
"name": "service_dict",
"type": "dict",
"description": "a definition for the $vectorize service",
"default": "None",
"value": "None"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for the HTTP request.\nNote that a 'read' timeout event will not block the action taken\nby the API server if it has received the request already.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "AsyncAstraDBCollection",
"type": "AsyncAstraDBCollection",
"description": "The created collection object."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.db.AsyncAstraDBCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for the HTTP request.\nNote that a 'read' timeout event will not block the action taken\nby the API server if it has received the request already.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "API_RESPONSE",
"description": "The response from the database."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "httpx",
"API_RESPONSE": "astrapy.core.core_types.API_RESPONSE",
"amake_request": "astrapy.core.utils.amake_request",
"make_request": "astrapy.core.utils.make_request",
"TypedDict": null,
"APIRequestError": null,
"api_request": null,
"async_api_request": null,
"async_raw_api_request": null,
"raw_api_request": null,
"OPS_API_RESPONSE": null,
"DEFAULT_DEV_OPS_API_VERSION": null,
"DEFAULT_DEV_OPS_AUTH_HEADER": null,
"DEFAULT_DEV_OPS_URL": null,
"TimeoutInfoWideType": null,
"http_methods": null,
"to_httpx_timeout": null,
"Dict": null,
"List": null,
"Protocol": null,
"Union": null,
"datetime": null,
"json": null,
"time": null,
"Iterable": null,
"__version__": null,
"DEFAULT_REDACTED_HEADERS": null,
"DEFAULT_TIMEOUT": null,
"UUID": null,
"ObjectId": null,
"uuid1": null,
"uuid3": null,
"uuid4": null,
"uuid5": null,
"uuid6": null,
"uuid7": null,
"uuid8": null,
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": null,
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": null,
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": null,
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": false,
"is_package": false,
"is_subpackage": false,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"Response",
"ValueError"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"ValueError"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"references": null,
"note": null,
"implemented_by": null,
"attributes": 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,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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",
"description": null,
"default": null,
"value": null
},
{
"name": "auth_header",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "token",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "method",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "json_data",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "url_params",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "path",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "timeout",
"type": "httpx.Timeout | float | None",
"description": null,
"default": null,
"value": null
},
{
"name": "additional_headers",
"type": "dict[str, str]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "httpx.Response",
"description": null
}
],
"gathered_types": [
"Client",
"Response",
"Timeout"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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",
"type": "bool",
"description": null,
"default": null,
"value": null
},
{
"name": "json_data",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "API_RESPONSE",
"description": null
}
],
"gathered_types": [
"astrapy.core.core_types.API_RESPONSE",
"Response"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"default": null,
"value": null
},
{
"name": "auth_header",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "token",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "method",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "json_data",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "url_params",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "path",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "skip_error_check",
"type": "bool",
"description": null,
"default": null,
"value": null
},
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "timeout",
"type": "httpx.Timeout | float | None",
"description": null,
"default": null,
"value": null
},
{
"name": "additional_headers",
"type": "dict[str, str]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "API_RESPONSE",
"description": null
}
],
"gathered_types": [
"Client",
"astrapy.core.core_types.API_RESPONSE",
"Timeout"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "auth_header",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "token",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "method",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "json_data",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "url_params",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "path",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "timeout",
"type": "httpx.Timeout | float | None",
"description": null,
"default": null,
"value": null
},
{
"name": "additional_headers",
"type": "dict[str, str]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "httpx.Response",
"description": null
}
],
"gathered_types": [
"AsyncClient",
"Response",
"Timeout"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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_error_check",
"type": "bool",
"description": null,
"default": null,
"value": null
},
{
"name": "json_data",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "API_RESPONSE",
"description": null
}
],
"gathered_types": [
"astrapy.core.core_types.API_RESPONSE",
"Response"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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",
"description": null,
"default": null,
"value": null
},
{
"name": "auth_header",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "token",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "method",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "json_data",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "url_params",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "path",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "skip_error_check",
"type": "bool",
"description": null,
"default": null,
"value": null
},
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "timeout",
"type": "httpx.Timeout | float | None",
"description": null,
"default": null,
"value": null
},
{
"name": "additional_headers",
"type": "dict[str, str]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "API_RESPONSE",
"description": null
}
],
"gathered_types": [
"AsyncClient",
"astrapy.core.core_types.API_RESPONSE",
"Timeout"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": "httpx",
"API_RESPONSE": "astrapy.core.core_types.API_RESPONSE",
"amake_request": null,
"make_request": null,
"TypedDict": "typing.TypedDict",
"APIRequestError": "astrapy.core.api.APIRequestError",
"api_request": "astrapy.core.api.api_request",
"async_api_request": "astrapy.core.api.async_api_request",
"async_raw_api_request": "astrapy.core.api.async_raw_api_request",
"raw_api_request": "astrapy.core.api.raw_api_request",
"OPS_API_RESPONSE": "astrapy.core.core_types.OPS_API_RESPONSE",
"DEFAULT_DEV_OPS_API_VERSION": "astrapy.core.defaults.DEFAULT_DEV_OPS_API_VERSION",
"DEFAULT_DEV_OPS_AUTH_HEADER": "astrapy.core.defaults.DEFAULT_DEV_OPS_AUTH_HEADER",
"DEFAULT_DEV_OPS_URL": "astrapy.core.defaults.DEFAULT_DEV_OPS_URL",
"TimeoutInfoWideType": "astrapy.core.utils.TimeoutInfoWideType",
"http_methods": "astrapy.core.utils.http_methods",
"to_httpx_timeout": "astrapy.core.utils.to_httpx_timeout",
"Dict": null,
"List": null,
"Protocol": null,
"Union": null,
"datetime": null,
"json": null,
"time": null,
"Iterable": null,
"__version__": null,
"DEFAULT_REDACTED_HEADERS": null,
"DEFAULT_TIMEOUT": null,
"UUID": null,
"ObjectId": null,
"uuid1": null,
"uuid3": null,
"uuid4": null,
"uuid5": null,
"uuid6": null,
"uuid7": null,
"uuid8": null,
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": null,
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": null,
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": null,
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": false,
"is_package": false,
"is_subpackage": false,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"references": null,
"note": null,
"implemented_by": null,
"attributes": 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,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": 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": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": 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": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"default": "None",
"value": null
},
{
"name": "dev_ops_api_version",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": 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_url, 'dev_ops_api_version': dev_ops_api_version, 'caller_name': caller_name, 'caller_version': caller_version}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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",
"description": null,
"default": "None",
"value": null
},
{
"name": "dev_ops_api_version",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "AstraDBOps",
"description": null
}
],
"gathered_types": [
"astrapy.core.ops.AstraDBOps"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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 | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "None",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
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": [
{
"name": "list",
"type": "OPS_API_RESPONSE",
"description": "a JSON list of dictionaries, one per database."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": [
{
"name": "list",
"type": "OPS_API_RESPONSE",
"description": "a JSON list of dictionaries, one per database."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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",
"value": "None"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "either a float (seconds) or a TimeoutInfo dict (see)",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "dict[str, str]",
"description": "A dictionary such as: {\"id\": the ID of the created database}"
},
{
"name": null,
"type": "dict[str, str]",
"description": "Raises an error if not successful."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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",
"value": "None"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "either a float (seconds) or a TimeoutInfo dict (see)",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "dict[str, str]",
"description": "A dictionary such as: {\"id\": the ID of the created database}"
},
{
"name": null,
"type": "dict[str, str]",
"description": "Raises an error if not successful."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "either a float (seconds) or a TimeoutInfo dict (see)",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "str",
"type": "str",
"description": "The identifier of the terminated database, or None if termination was unsuccessful."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "either a float (seconds) or a TimeoutInfo dict (see)",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "str",
"type": "str",
"description": "The identifier of the terminated database, or None if termination was unsuccessful."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "options",
"type": "dict",
"description": "Additional options for the request.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "API_RESPONSE",
"description": "A JSON response containing the details of the specified database."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the request.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "API_RESPONSE",
"description": "A JSON response containing the details of the specified database."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "keyspace",
"type": "str",
"description": "The name of the keyspace to create.",
"default": "''",
"value": "''"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "either a float (seconds) or a TimeoutInfo dict (see)",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "dict[str, str]",
"description": "{\"ok\": 1} if successful. Raises errors otherwise."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "keyspace",
"type": "str",
"description": "The name of the keyspace to create.",
"default": "''",
"value": "''"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "either a float (seconds) or a TimeoutInfo dict (see)",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "dict[str, str]",
"description": "{\"ok\": 1} if successful. Raises errors otherwise."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "keyspace",
"type": "str",
"description": "The name of the keyspace to create.",
"default": "''",
"value": "''"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "either a float (seconds) or a TimeoutInfo dict (see)",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "str",
"type": "str",
"description": "The identifier of the deleted keyspace. Otherwise raises an error."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "keyspace",
"type": "str",
"description": "The name of the keyspace to create.",
"default": "''",
"value": "''"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "either a float (seconds) or a TimeoutInfo dict (see)",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "str",
"type": "str",
"description": "The identifier of the deleted keyspace. Otherwise raises an error."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after parking the database."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after unparking the database."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "options",
"type": "dict",
"description": "The specifications for the resize operation.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after the resize operation."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the password reset.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after resetting the password."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The secure bundle URL and related information."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "A list of datacenters and their details."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "options",
"type": "dict",
"description": "Specifications for the new datacenter.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after creating the datacenter."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "datacenter",
"type": "str",
"description": "The identifier of the datacenter to terminate.",
"default": "''",
"value": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after terminating the datacenter."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The current access list for the database."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "access_list",
"type": "dict",
"description": "The new access list to be set.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after replacing the access list."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "access_list",
"type": "dict",
"description": "The updates to be applied to the access list.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after updating the access list."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "address",
"type": "dict",
"description": "The address details to add to the access list.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after adding the address."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after deleting the access list."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The private link information for the database."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "datacenter",
"type": "str",
"description": "The identifier of the datacenter.",
"default": "''",
"value": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The private link information for the specified datacenter."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "datacenter",
"type": "str",
"description": "The identifier of the datacenter.",
"default": "''",
"value": "''"
},
{
"name": "private_link",
"type": "dict",
"description": "The private link configuration details.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after creating the private link."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "datacenter",
"type": "str",
"description": "The identifier of the datacenter.",
"default": "''",
"value": "''"
},
{
"name": "endpoint",
"type": "dict",
"description": "The endpoint configuration details.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after creating the endpoint."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "datacenter",
"type": "str",
"description": "The identifier of the datacenter.",
"default": "''",
"value": "''"
},
{
"name": "endpoint",
"type": "dict",
"description": "The updated endpoint configuration details.",
"default": "{}",
"value": "{}"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after updating the endpoint."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "datacenter",
"type": "str",
"description": "The identifier of the datacenter.",
"default": "''",
"value": "''"
},
{
"name": "endpoint",
"type": "str",
"description": "The identifier of the endpoint.",
"default": "''",
"value": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The endpoint information for the specified datacenter."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": "''"
},
{
"name": "datacenter",
"type": "str",
"description": "The identifier of the datacenter.",
"default": "''",
"value": "''"
},
{
"name": "endpoint",
"type": "str",
"description": "The identifier of the endpoint to delete.",
"default": "''",
"value": "''"
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after deleting the endpoint."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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
}
],
"returns": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "A list of available classic regions."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "A list of available regions for serverless deployment."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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",
"type": "OPS_API_RESPONSE",
"description": "A list of roles within the organization."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
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": [
{
"name": "dict",
"type": "OPS_API_RESPONSE",
"description": "The response from the server after creating the role."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.OPS_API_RESPONSE"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.