id
stringlengths 7
77
| text
stringlengths 0
3.4k
| metadata
dict |
|---|---|---|
astrapy.meta.check_update_db_namespace_keyspace
|
{
"kind": "function",
"name": "check_update_db_namespace_keyspace",
"path": "astrapy.meta.check_update_db_namespace_keyspace",
"parameters": [
{
"name": "update_db_keyspace",
"type": "bool | None",
"description": null,
"default": null,
"value": null
},
{
"name": "update_db_namespace",
"type": "bool | None",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "bool | 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
|
{
"kind": "module",
"name": "core",
"path": "astrapy.core",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": null,
"Any": null,
"cast": null,
"httpx": null,
"API_RESPONSE": null,
"amake_request": null,
"make_request": null,
"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": "warnings",
"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": "deprecation.DeprecatedWarning",
"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": "inspect",
"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": true,
"is_package": false,
"is_subpackage": true,
"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.DEPRECATED_MODULE_PATHS
|
{
"kind": "attribute",
"name": "DEPRECATED_MODULE_PATHS",
"path": "astrapy.core.DEPRECATED_MODULE_PATHS",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEPRECATED_MODULE_PATHS = {'astrapy.api', 'astrapy.core', 'astrapy.db', 'astrapy.ops'}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.issue_deprecation_warning
|
Issue a DeprecatedWarning (subclass of DeprecationWarning).
In order to correctly refer to user code, this function needs to
dynamically adjust the `stacklevel` parameter.
|
{
"kind": "function",
"name": "issue_deprecation_warning",
"path": "astrapy.core.issue_deprecation_warning",
"parameters": 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
|
{
"kind": "module",
"name": "db",
"path": "astrapy.core.db",
"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": null,
"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": 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": "astrapy.core.utils.TimeoutInfoWideType",
"http_methods": "astrapy.core.utils.http_methods",
"to_httpx_timeout": "astrapy.core.utils.to_httpx_timeout",
"Dict": null,
"List": "typing.List",
"Protocol": null,
"Union": "typing.Union",
"datetime": null,
"json": "json",
"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": "asyncio",
"warnings": null,
"ThreadPoolExecutor": "concurrent.futures.ThreadPoolExecutor",
"TracebackType": "types.TracebackType",
"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": "astrapy.core.utils.normalize_for_api",
"restore_from_api": "astrapy.core.utils.restore_from_api",
"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": "queue",
"threading": "threading",
"weakref": "weakref",
"AsyncGenerator": "collections.abc.AsyncGenerator",
"AsyncIterator": "collections.abc.AsyncIterator",
"partial": "functools.partial",
"Callable": "typing.Callable",
"Iterator": "typing.Iterator",
"API_DOC": "astrapy.core.core_types.API_DOC",
"AsyncPaginableRequestMethod": "astrapy.core.core_types.AsyncPaginableRequestMethod",
"PaginableRequestMethod": "astrapy.core.core_types.PaginableRequestMethod",
"DEFAULT_AUTH_HEADER": "astrapy.core.defaults.DEFAULT_AUTH_HEADER",
"DEFAULT_INSERT_NUM_DOCUMENTS": "astrapy.core.defaults.DEFAULT_INSERT_NUM_DOCUMENTS",
"DEFAULT_JSON_API_PATH": "astrapy.core.defaults.DEFAULT_JSON_API_PATH",
"DEFAULT_JSON_API_VERSION": "astrapy.core.defaults.DEFAULT_JSON_API_VERSION",
"DEFAULT_KEYSPACE_NAME": "astrapy.core.defaults.DEFAULT_KEYSPACE_NAME",
"convert_vector_to_floats": "astrapy.core.utils.convert_vector_to_floats",
"make_payload": "astrapy.core.utils.make_payload",
"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.db.logger
|
{
"kind": "attribute",
"name": "logger",
"path": "astrapy.core.db.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.db._PrefetchIterator.queue
|
{
"kind": "attribute",
"name": "queue",
"path": "astrapy.core.db._PrefetchIterator.queue",
"parameters": null,
"returns": null,
"gathered_types": [
"Queue",
"astrapy.core.core_types.API_DOC"
],
"value": "queue: queue.Queue[API_DOC | None] = queue.Queue(prefetched)",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db._PrefetchIterator.request_method
|
{
"kind": "attribute",
"name": "request_method",
"path": "astrapy.core.db._PrefetchIterator.request_method",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "request_method = request_method",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db._PrefetchIterator.options
|
{
"kind": "attribute",
"name": "options",
"path": "astrapy.core.db._PrefetchIterator.options",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "options = options",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db._PrefetchIterator.raw_response_callback
|
{
"kind": "attribute",
"name": "raw_response_callback",
"path": "astrapy.core.db._PrefetchIterator.raw_response_callback",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_response_callback = raw_response_callback",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db._PrefetchIterator.initialised
|
{
"kind": "attribute",
"name": "initialised",
"path": "astrapy.core.db._PrefetchIterator.initialised",
"parameters": null,
"returns": null,
"gathered_types": [
"Event"
],
"value": "initialised = threading.Event()",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db._PrefetchIterator.stop
|
{
"kind": "attribute",
"name": "stop",
"path": "astrapy.core.db._PrefetchIterator.stop",
"parameters": null,
"returns": null,
"gathered_types": [
"Event"
],
"value": "stop = threading.Event()",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db._PrefetchIterator.thread
|
{
"kind": "attribute",
"name": "thread",
"path": "astrapy.core.db._PrefetchIterator.thread",
"parameters": null,
"returns": null,
"gathered_types": [
"Thread",
"_PrefetchIterator"
],
"value": "thread = threading.Thread(target=_PrefetchIterator.queued_paginate, args=(weakref.proxy(self),))",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db._PrefetchIterator.queue_put
|
{
"kind": "function",
"name": "queue_put",
"path": "astrapy.core.db._PrefetchIterator.queue_put",
"parameters": [
{
"name": "q",
"type": "queue.Queue[API_DOC | None]",
"description": null,
"default": null,
"value": null
},
{
"name": "item",
"type": "API_DOC | None",
"description": null,
"default": null,
"value": null
},
{
"name": "stop",
"type": "threading.Event",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "None",
"description": null
}
],
"gathered_types": [
"Queue",
"Event",
"astrapy.core.core_types.API_DOC"
],
"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._PrefetchIterator.queued_paginate
|
{
"kind": "function",
"name": "queued_paginate",
"path": "astrapy.core.db._PrefetchIterator.queued_paginate",
"parameters": 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.AstraDBCollection
|
{
"kind": "class",
"name": "AstraDBCollection",
"path": "astrapy.core.db.AstraDBCollection",
"parameters": [
{
"name": "collection_name",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "astra_db",
"type": "AstraDB | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "token",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "api_endpoint",
"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
},
{
"name": "additional_headers",
"type": "dict[str, str]",
"description": null,
"default": "{}",
"value": null
}
],
"returns": 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.AstraDBCollection.client
|
{
"kind": "attribute",
"name": "client",
"path": "astrapy.core.db.AstraDBCollection.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.db.AstraDBCollection.astra_db
|
{
"kind": "attribute",
"name": "astra_db",
"path": "astrapy.core.db.AstraDBCollection.astra_db",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "astra_db = astra_db",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db.AstraDBCollection.caller_name
|
{
"kind": "attribute",
"name": "caller_name",
"path": "astrapy.core.db.AstraDBCollection.caller_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "caller_name: str | None = self.astra_db.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.AstraDBCollection.caller_version
|
{
"kind": "attribute",
"name": "caller_version",
"path": "astrapy.core.db.AstraDBCollection.caller_version",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "caller_version: str | None = self.astra_db.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.AstraDBCollection.additional_headers
|
{
"kind": "attribute",
"name": "additional_headers",
"path": "astrapy.core.db.AstraDBCollection.additional_headers",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "additional_headers = additional_headers",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db.AstraDBCollection.collection_name
|
{
"kind": "attribute",
"name": "collection_name",
"path": "astrapy.core.db.AstraDBCollection.collection_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "collection_name = collection_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.AstraDBCollection.base_path
|
{
"kind": "attribute",
"name": "base_path",
"path": "astrapy.core.db.AstraDBCollection.base_path",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "base_path: str = f'{self.astra_db.base_path}/{self.collection_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.AstraDBCollection.copy
|
{
"kind": "function",
"name": "copy",
"path": "astrapy.core.db.AstraDBCollection.copy",
"parameters": [
{
"name": "collection_name",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"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
},
{
"name": "additional_headers",
"type": "dict[str, str] | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "AstraDBCollection",
"description": null
}
],
"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.AstraDBCollection.to_async
|
{
"kind": "function",
"name": "to_async",
"path": "astrapy.core.db.AstraDBCollection.to_async",
"parameters": null,
"returns": [
{
"name": null,
"type": "AsyncAstraDBCollection",
"description": null
}
],
"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.AstraDBCollection.set_caller
|
{
"kind": "function",
"name": "set_caller",
"path": "astrapy.core.db.AstraDBCollection.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.AstraDBCollection.post_raw_request
|
{
"kind": "function",
"name": "post_raw_request",
"path": "astrapy.core.db.AstraDBCollection.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.AstraDBCollection.get
|
Retrieve a document from the collection by its path.
|
{
"kind": "function",
"name": "get",
"path": "astrapy.core.db.AstraDBCollection.get",
"parameters": [
{
"name": "path",
"type": "str",
"description": "The path of the document to retrieve.",
"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 | None",
"description": "The retrieved document."
}
],
"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.AstraDBCollection.find
|
Find documents in the collection that match the given filter.
|
{
"kind": "function",
"name": "find",
"path": "astrapy.core.db.AstraDBCollection.find",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "projection",
"type": "dict",
"description": "Specifies the fields to return.",
"default": "None",
"value": "None"
},
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to return matching documents.",
"default": "None",
"value": "None"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the query.",
"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": "The query response containing matched documents."
}
],
"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.AstraDBCollection.vector_find
|
Perform a vector-based search in the collection.
|
{
"kind": "function",
"name": "vector_find",
"path": "astrapy.core.db.AstraDBCollection.vector_find",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "limit",
"type": "int",
"description": "The maximum number of documents to return.",
"default": null,
"value": null
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "fields",
"type": "list",
"description": "Specifies the fields to return.",
"default": "None",
"value": "None"
},
{
"name": "include_similarity",
"type": "bool",
"description": "Whether to include similarity score in the result.",
"default": "True",
"value": "True"
},
{
"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": "list",
"type": "list[API_DOC]",
"description": "A list of documents matching the vector search criteria."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AstraDBCollection.paginate
|
Generate paginated results for a given database query method.
|
{
"kind": "function",
"name": "paginate",
"path": "astrapy.core.db.AstraDBCollection.paginate",
"parameters": [
{
"name": "request_method",
"type": "function",
"description": "The database query method to paginate.",
"default": null,
"value": null
},
{
"name": "options",
"type": "dict",
"description": "Options for the database query.",
"default": null,
"value": null
},
{
"name": "prefetched",
"type": "int",
"description": "Number of pre-fetched documents.",
"default": null,
"value": null
},
{
"name": "raw_response_callback",
"type": "Callable[[dict[str, Any]], None] | None",
"description": "an optional callback invoked at each new\nresponse coming from the API. The only argument is the raw\nAPI response and the callback must return None.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "Iterator[API_DOC]",
"description": null
}
],
"gathered_types": [
"astrapy.core.core_types.PaginableRequestMethod",
"astrapy.core.core_types.API_DOC"
],
"value": null,
"yields": [
{
"name": "dict",
"type": "API_DOC",
"description": "The next document in the paginated result set."
}
],
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.db.AstraDBCollection.paginated_find
|
Perform a paginated search in the collection.
|
{
"kind": "function",
"name": "paginated_find",
"path": "astrapy.core.db.AstraDBCollection.paginated_find",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "projection",
"type": "dict",
"description": "Specifies the fields to return.",
"default": "None",
"value": "None"
},
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to return matching documents.",
"default": "None",
"value": "None"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the query.",
"default": "None",
"value": "None"
},
{
"name": "prefetched",
"type": "int",
"description": "Number of pre-fetched documents.",
"default": "None",
"value": "None"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for each\nsingle HTTP request.\nThis is a paginated method, that issues several requests as it\nneeds more data. This parameter controls a single 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"
},
{
"name": "raw_response_callback",
"type": "Callable[[dict[str, Any]], None] | None",
"description": "an optional callback invoked at each new\nresponse coming from the API. The only argument is the raw\nAPI response and the callback must return None.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "generator",
"type": "Iterator[API_DOC]",
"description": "A generator yielding documents in the paginated result set."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AstraDBCollection.pop
|
Pop the last data in the tags array
|
{
"kind": "function",
"name": "pop",
"path": "astrapy.core.db.AstraDBCollection.pop",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "pop",
"type": "dict",
"description": "The pop to apply to the tags.",
"default": null,
"value": null
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the update operation.",
"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 original document before the update."
}
],
"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.AstraDBCollection.push
|
Push new data to the tags array
|
{
"kind": "function",
"name": "push",
"path": "astrapy.core.db.AstraDBCollection.push",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "push",
"type": "dict",
"description": "The push to apply to the tags.",
"default": null,
"value": null
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the update operation.",
"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 result of the update operation."
}
],
"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.AstraDBCollection.find_one_and_replace
|
Find a single document and replace it.
|
{
"kind": "function",
"name": "find_one_and_replace",
"path": "astrapy.core.db.AstraDBCollection.find_one_and_replace",
"parameters": [
{
"name": "replacement",
"type": "dict",
"description": "The new document to replace the existing one.",
"default": null,
"value": null
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to find the document.",
"default": "None",
"value": "None"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the operation.",
"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": "The result of the find and replace operation."
}
],
"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.AstraDBCollection.vector_find_one_and_replace
|
Perform a vector-based search and replace the first matched document.
|
{
"kind": "function",
"name": "vector_find_one_and_replace",
"path": "astrapy.core.db.AstraDBCollection.vector_find_one_and_replace",
"parameters": [
{
"name": "vector",
"type": "dict",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "replacement",
"type": "dict",
"description": "The new document to replace the existing one.",
"default": null,
"value": null
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "fields",
"type": "list",
"description": "Specifies the fields to return in the result.",
"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": null,
"type": "API_DOC | None",
"description": "dict or None: either the matched document or None if nothing found"
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AstraDBCollection.find_one_and_update
|
Find a single document and update it.
|
{
"kind": "function",
"name": "find_one_and_update",
"path": "astrapy.core.db.AstraDBCollection.find_one_and_update",
"parameters": [
{
"name": "update",
"type": "dict",
"description": "The update to apply to the document.",
"default": null,
"value": null
},
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to find the document.",
"default": "{}",
"value": "{}"
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the operation.",
"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": "The result of the find and update operation."
}
],
"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.AstraDBCollection.vector_find_one_and_update
|
Perform a vector-based search and update the first matched document.
|
{
"kind": "function",
"name": "vector_find_one_and_update",
"path": "astrapy.core.db.AstraDBCollection.vector_find_one_and_update",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "update",
"type": "dict",
"description": "The update to apply to the matched document.",
"default": null,
"value": null
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents before applying the vector search.",
"default": "None",
"value": "None"
},
{
"name": "fields",
"type": "list",
"description": "Specifies the fields to return in the updated document.",
"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": null,
"type": "API_DOC | None",
"description": "dict or None: The result of the vector-based find and\nupdate operation, or None if nothing found"
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AstraDBCollection.find_one_and_delete
|
Find a single document and delete it.
|
{
"kind": "function",
"name": "find_one_and_delete",
"path": "astrapy.core.db.AstraDBCollection.find_one_and_delete",
"parameters": [
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to find the document.",
"default": "{}",
"value": "{}"
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "projection",
"type": "dict",
"description": "Specifies the fields to return.",
"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": "The result of the find and delete operation."
}
],
"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.AstraDBCollection.count_documents
|
Count documents matching a given predicate (expressed as filter).
|
{
"kind": "function",
"name": "count_documents",
"path": "astrapy.core.db.AstraDBCollection.count_documents",
"parameters": [
{
"name": "filter",
"type": "dict, defaults to {}",
"description": "Criteria to filter documents.",
"default": "{}",
"value": "{}"
},
{
"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, either\n{\"status\": {\"count\": <NUMBER> }}"
},
{
"name": null,
"type": "API_RESPONSE",
"description": "or\n{\"errors\": [...]}"
}
],
"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.AstraDBCollection.find_one
|
Find a single document in the collection.
|
{
"kind": "function",
"name": "find_one",
"path": "astrapy.core.db.AstraDBCollection.find_one",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "{}",
"value": "{}"
},
{
"name": "projection",
"type": "dict",
"description": "Specifies the fields to return.",
"default": "{}",
"value": "{}"
},
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to return the document.",
"default": "{}",
"value": "{}"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the query.",
"default": "{}",
"value": "{}"
},
{
"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, either\n{\"data\": {\"document\": <DOCUMENT> }}"
},
{
"name": null,
"type": "API_RESPONSE",
"description": "or\n{\"data\": {\"document\": None}}"
},
{
"name": null,
"type": "API_RESPONSE",
"description": "depending on whether a matching document is found or not."
}
],
"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.AstraDBCollection.vector_find_one
|
Perform a vector-based search to find a single document in the collection.
|
{
"kind": "function",
"name": "vector_find_one",
"path": "astrapy.core.db.AstraDBCollection.vector_find_one",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "filter",
"type": "dict",
"description": "Additional criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "fields",
"type": "list",
"description": "Specifies the fields to return in the result.",
"default": "None",
"value": "None"
},
{
"name": "include_similarity",
"type": "bool",
"description": "Whether to include similarity score in the result.",
"default": "True",
"value": "True"
},
{
"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": null,
"type": "API_DOC | None",
"description": "dict or None: The found document or None if no matching document is found."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AstraDBCollection.insert_one
|
Insert a single document into the collection.
|
{
"kind": "function",
"name": "insert_one",
"path": "astrapy.core.db.AstraDBCollection.insert_one",
"parameters": [
{
"name": "document",
"type": "dict",
"description": "The document to insert.",
"default": null,
"value": null
},
{
"name": "failures_allowed",
"type": "bool",
"description": "Whether to allow failures in the insert operation.",
"default": "False",
"value": "False"
},
{
"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 after the insert operation."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC",
"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.AstraDBCollection.insert_many
|
Insert multiple documents into the collection.
|
{
"kind": "function",
"name": "insert_many",
"path": "astrapy.core.db.AstraDBCollection.insert_many",
"parameters": [
{
"name": "documents",
"type": "list",
"description": "A list of documents to insert.",
"default": null,
"value": null
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the insert operation.",
"default": "None",
"value": "None"
},
{
"name": "partial_failures_allowed",
"type": "bool",
"description": "Whether to allow partial\nfailures through the insertion (i.e. on some documents).",
"default": "False",
"value": "False"
},
{
"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 after the insert operation."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC",
"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.AstraDBCollection.chunked_insert_many
|
Insert multiple documents into the collection, handling chunking and
optionally with concurrent insertions.
|
{
"kind": "function",
"name": "chunked_insert_many",
"path": "astrapy.core.db.AstraDBCollection.chunked_insert_many",
"parameters": [
{
"name": "documents",
"type": "list",
"description": "A list of documents to insert.",
"default": null,
"value": null
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the insert operation.",
"default": "None",
"value": "None"
},
{
"name": "partial_failures_allowed",
"type": "bool",
"description": "Whether to allow partial\nfailures in the chunk. Should be used combined with\noptions={\"ordered\": False} in most cases.",
"default": "False",
"value": "False"
},
{
"name": "chunk_size",
"type": "int",
"description": "Override the default insertion chunk size.",
"default": "DEFAULT_INSERT_NUM_DOCUMENTS",
"value": "DEFAULT_INSERT_NUM_DOCUMENTS"
},
{
"name": "concurrency",
"type": "int",
"description": "The number of concurrent chunk insertions.\nDefault is no concurrency.",
"default": "1",
"value": "1"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for each single HTTP request.\nThis method runs a number of HTTP requests as it works on chunked\ndata. The timeout refers to each individual such 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": "list",
"type": "list[API_RESPONSE | Exception]",
"description": "The responses from the database after the chunked insert operation.\nThis is a list of individual responses from the API: the caller\nwill need to inspect them all, e.g. to collate the inserted IDs."
}
],
"gathered_types": [
"astrapy.core.core_types.API_DOC",
"astrapy.core.defaults.DEFAULT_INSERT_NUM_DOCUMENTS",
"astrapy.core.core_types.API_RESPONSE",
"astrapy.core.utils.TimeoutInfoWideType",
"Exception"
],
"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.AstraDBCollection.update_one
|
Update a single document in the collection.
|
{
"kind": "function",
"name": "update_one",
"path": "astrapy.core.db.AstraDBCollection.update_one",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "update",
"type": "dict",
"description": "The update to apply to the document.",
"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"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the operation.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "API_RESPONSE",
"description": "The response from the database after the update operation."
}
],
"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.AstraDBCollection.update_many
|
Updates multiple documents in the collection.
|
{
"kind": "function",
"name": "update_many",
"path": "astrapy.core.db.AstraDBCollection.update_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "update",
"type": "dict",
"description": "The update to apply to the document.",
"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 after the update operation."
}
],
"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.AstraDBCollection.replace
|
Replace a document in the collection.
|
{
"kind": "function",
"name": "replace",
"path": "astrapy.core.db.AstraDBCollection.replace",
"parameters": [
{
"name": "path",
"type": "str",
"description": "The path to the document to replace.",
"default": null,
"value": null
},
{
"name": "document",
"type": "dict",
"description": "The new document to replace the existing one.",
"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 after the replace operation."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC",
"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.AstraDBCollection.delete_one
|
Delete a single document from the collection based on its ID.
|
{
"kind": "function",
"name": "delete_one",
"path": "astrapy.core.db.AstraDBCollection.delete_one",
"parameters": [
{
"name": "id",
"type": "str",
"description": "The ID of the document 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 after the delete operation."
}
],
"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.AstraDBCollection.delete_one_by_predicate
|
Delete a single document from the collection based on a filter clause
|
{
"kind": "function",
"name": "delete_one_by_predicate",
"path": "astrapy.core.db.AstraDBCollection.delete_one_by_predicate",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "any filter dictionary",
"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 after the delete operation."
}
],
"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.AstraDBCollection.delete_many
|
Delete many documents from the collection based on a filter condition
|
{
"kind": "function",
"name": "delete_many",
"path": "astrapy.core.db.AstraDBCollection.delete_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the documents to delete.",
"default": null,
"value": null
},
{
"name": "skip_error_check",
"type": "bool",
"description": "whether to ignore the check for API error\nand return the response untouched. Default is False.",
"default": "False",
"value": "False"
},
{
"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 after the delete operation."
}
],
"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.AstraDBCollection.chunked_delete_many
|
Delete many documents from the collection based on a filter condition,
chaining several API calls until exhaustion of the documents to delete.
|
{
"kind": "function",
"name": "chunked_delete_many",
"path": "astrapy.core.db.AstraDBCollection.chunked_delete_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the documents to delete.",
"default": null,
"value": null
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for each single HTTP request.\nThis method runs a number of HTTP requests as it works on a\npagination basis. The timeout refers to each individual such 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": null,
"type": "list[API_RESPONSE]",
"description": "List[dict]: The responses from the database from all the calls"
}
],
"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.AstraDBCollection.clear
|
Clear the collection, deleting all documents
|
{
"kind": "function",
"name": "clear",
"path": "astrapy.core.db.AstraDBCollection.clear",
"parameters": [
{
"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.AstraDBCollection.delete_subdocument
|
Delete a subdocument or field from a document in the collection.
|
{
"kind": "function",
"name": "delete_subdocument",
"path": "astrapy.core.db.AstraDBCollection.delete_subdocument",
"parameters": [
{
"name": "id",
"type": "str",
"description": "The ID of the document containing the subdocument.",
"default": null,
"value": null
},
{
"name": "subdoc",
"type": "str",
"description": "The key of the subdocument or field to remove.",
"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 after the update operation."
}
],
"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.AstraDBCollection.upsert_one
|
Emulate an upsert operation for a single document in the collection.
This method attempts to insert the document.
If a document with the same _id exists, it updates the existing document.
|
{
"kind": "function",
"name": "upsert_one",
"path": "astrapy.core.db.AstraDBCollection.upsert_one",
"parameters": [
{
"name": "document",
"type": "dict",
"description": "The document to insert or update.",
"default": null,
"value": null
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for the HTTP requests.\nThis method may issue one or two requests, depending on what\nis detected on DB. This timeout controls each HTTP request individually.\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": "str",
"type": "str",
"description": "The _id of the inserted or updated document."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AstraDBCollection.upsert_many
|
Emulate an upsert operation for multiple documents in the collection.
This method attempts to insert the documents.
If a document with the same _id exists, it updates the existing document.
|
{
"kind": "function",
"name": "upsert_many",
"path": "astrapy.core.db.AstraDBCollection.upsert_many",
"parameters": [
{
"name": "documents",
"type": "List[dict]",
"description": "The documents to insert or update.",
"default": null,
"value": null
},
{
"name": "concurrency",
"type": "int",
"description": "The number of concurrent upserts.",
"default": "1",
"value": "1"
},
{
"name": "partial_failures_allowed",
"type": "bool",
"description": "Whether to allow partial\nfailures in the batch.",
"default": "False",
"value": "False"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for each HTTP request.\nThis method issues a separate HTTP request for each document to\ninsert: the timeout controls each such request individually.\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": null,
"type": "list[str | Exception]",
"description": "List[Union[str, Exception]]: A list of \"_id\"s of the inserted or updated documents."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC",
"Exception"
],
"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.AsyncAstraDBCollection
|
{
"kind": "class",
"name": "AsyncAstraDBCollection",
"path": "astrapy.core.db.AsyncAstraDBCollection",
"parameters": [
{
"name": "collection_name",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "astra_db",
"type": "AsyncAstraDB | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "token",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "api_endpoint",
"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
},
{
"name": "additional_headers",
"type": "dict[str, str]",
"description": null,
"default": "{}",
"value": null
}
],
"returns": 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.AsyncAstraDBCollection.astra_db
|
{
"kind": "attribute",
"name": "astra_db",
"path": "astrapy.core.db.AsyncAstraDBCollection.astra_db",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.core.db.AsyncAstraDB"
],
"value": "astra_db: AsyncAstraDB = astra_db",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db.AsyncAstraDBCollection.caller_name
|
{
"kind": "attribute",
"name": "caller_name",
"path": "astrapy.core.db.AsyncAstraDBCollection.caller_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "caller_name: str | None = self.astra_db.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.AsyncAstraDBCollection.caller_version
|
{
"kind": "attribute",
"name": "caller_version",
"path": "astrapy.core.db.AsyncAstraDBCollection.caller_version",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "caller_version: str | None = self.astra_db.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.AsyncAstraDBCollection.additional_headers
|
{
"kind": "attribute",
"name": "additional_headers",
"path": "astrapy.core.db.AsyncAstraDBCollection.additional_headers",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "additional_headers = additional_headers",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db.AsyncAstraDBCollection.client
|
{
"kind": "attribute",
"name": "client",
"path": "astrapy.core.db.AsyncAstraDBCollection.client",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "client = astra_db.client",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.core.db.AsyncAstraDBCollection.collection_name
|
{
"kind": "attribute",
"name": "collection_name",
"path": "astrapy.core.db.AsyncAstraDBCollection.collection_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "collection_name = collection_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.AsyncAstraDBCollection.base_path
|
{
"kind": "attribute",
"name": "base_path",
"path": "astrapy.core.db.AsyncAstraDBCollection.base_path",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "base_path: str = f'{self.astra_db.base_path}/{self.collection_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.AsyncAstraDBCollection.copy
|
{
"kind": "function",
"name": "copy",
"path": "astrapy.core.db.AsyncAstraDBCollection.copy",
"parameters": [
{
"name": "collection_name",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"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
},
{
"name": "additional_headers",
"type": "dict[str, str] | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "AsyncAstraDBCollection",
"description": null
}
],
"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.AsyncAstraDBCollection.set_caller
|
{
"kind": "function",
"name": "set_caller",
"path": "astrapy.core.db.AsyncAstraDBCollection.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.AsyncAstraDBCollection.to_sync
|
{
"kind": "function",
"name": "to_sync",
"path": "astrapy.core.db.AsyncAstraDBCollection.to_sync",
"parameters": null,
"returns": [
{
"name": null,
"type": "AstraDBCollection",
"description": null
}
],
"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.AsyncAstraDBCollection.post_raw_request
|
{
"kind": "function",
"name": "post_raw_request",
"path": "astrapy.core.db.AsyncAstraDBCollection.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.AsyncAstraDBCollection.get
|
Retrieve a document from the collection by its path.
|
{
"kind": "function",
"name": "get",
"path": "astrapy.core.db.AsyncAstraDBCollection.get",
"parameters": [
{
"name": "path",
"type": "str",
"description": "The path of the document to retrieve.",
"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 | None",
"description": "The retrieved document."
}
],
"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.AsyncAstraDBCollection.find
|
Find documents in the collection that match the given filter.
|
{
"kind": "function",
"name": "find",
"path": "astrapy.core.db.AsyncAstraDBCollection.find",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "projection",
"type": "dict",
"description": "Specifies the fields to return.",
"default": "None",
"value": "None"
},
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to return matching documents.",
"default": "None",
"value": "None"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the query.",
"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": "The query response containing matched documents."
}
],
"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.AsyncAstraDBCollection.vector_find
|
Perform a vector-based search in the collection.
|
{
"kind": "function",
"name": "vector_find",
"path": "astrapy.core.db.AsyncAstraDBCollection.vector_find",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "limit",
"type": "int",
"description": "The maximum number of documents to return.",
"default": null,
"value": null
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "fields",
"type": "list",
"description": "Specifies the fields to return.",
"default": "None",
"value": "None"
},
{
"name": "include_similarity",
"type": "bool",
"description": "Whether to include similarity score in the result.",
"default": "True",
"value": "True"
},
{
"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": "list",
"type": "list[API_DOC]",
"description": "A list of documents matching the vector search criteria."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AsyncAstraDBCollection.paginate
|
Generate paginated results for a given database query method.
|
{
"kind": "function",
"name": "paginate",
"path": "astrapy.core.db.AsyncAstraDBCollection.paginate",
"parameters": [
{
"name": "request_method",
"type": "function",
"description": "The database query method to paginate.",
"default": null,
"value": null
},
{
"name": "options",
"type": "dict",
"description": "Options for the database query.",
"default": null,
"value": null
},
{
"name": "prefetched",
"type": "int",
"description": "Number of pre-fetched documents.",
"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"
},
{
"name": "raw_response_callback",
"type": "Callable[[dict[str, Any]], None] | None",
"description": "an optional callback invoked at each new\nresponse coming from the API. The only argument is the raw\nAPI response and the callback must return None.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "AsyncGenerator[API_DOC, None]",
"description": null
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC",
"astrapy.core.core_types.AsyncPaginableRequestMethod"
],
"value": null,
"yields": [
{
"name": "dict",
"type": "AsyncGenerator[API_DOC, None]",
"description": "The next document in the paginated result set."
}
],
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.core.db.AsyncAstraDBCollection.paginated_find
|
Perform a paginated search in the collection.
|
{
"kind": "function",
"name": "paginated_find",
"path": "astrapy.core.db.AsyncAstraDBCollection.paginated_find",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "projection",
"type": "dict",
"description": "Specifies the fields to return.",
"default": "None",
"value": "None"
},
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to return matching documents.",
"default": "None",
"value": "None"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the query.",
"default": "None",
"value": "None"
},
{
"name": "prefetched",
"type": "int",
"description": "Number of pre-fetched documents",
"default": "None",
"value": "None"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for each\nsingle HTTP request.\nThis is a paginated method, that issues several requests as it\nneeds more data. This parameter controls a single 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"
},
{
"name": "raw_response_callback",
"type": "Callable[[dict[str, Any]], None] | None",
"description": "an optional callback invoked at each new\nresponse coming from the API. The only argument is the raw\nAPI response and the callback must return None.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "generator",
"type": "AsyncIterator[API_DOC]",
"description": "A generator yielding documents in the paginated result set."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AsyncAstraDBCollection.pop
|
Pop the last data in the tags array
|
{
"kind": "function",
"name": "pop",
"path": "astrapy.core.db.AsyncAstraDBCollection.pop",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "pop",
"type": "dict",
"description": "The pop to apply to the tags.",
"default": null,
"value": null
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the update operation.",
"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 original document before the update."
}
],
"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.AsyncAstraDBCollection.push
|
Push new data to the tags array
|
{
"kind": "function",
"name": "push",
"path": "astrapy.core.db.AsyncAstraDBCollection.push",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "push",
"type": "dict",
"description": "The push to apply to the tags.",
"default": null,
"value": null
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the update operation.",
"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 result of the update operation."
}
],
"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.AsyncAstraDBCollection.find_one_and_replace
|
Find a single document and replace it.
|
{
"kind": "function",
"name": "find_one_and_replace",
"path": "astrapy.core.db.AsyncAstraDBCollection.find_one_and_replace",
"parameters": [
{
"name": "replacement",
"type": "dict",
"description": "The new document to replace the existing one.",
"default": null,
"value": null
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to find the document.",
"default": "None",
"value": "None"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the operation.",
"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": "The result of the find and replace operation."
}
],
"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.AsyncAstraDBCollection.vector_find_one_and_replace
|
Perform a vector-based search and replace the first matched document.
|
{
"kind": "function",
"name": "vector_find_one_and_replace",
"path": "astrapy.core.db.AsyncAstraDBCollection.vector_find_one_and_replace",
"parameters": [
{
"name": "vector",
"type": "dict",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "replacement",
"type": "dict",
"description": "The new document to replace the existing one.",
"default": null,
"value": null
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "fields",
"type": "list",
"description": "Specifies the fields to return in the result.",
"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": null,
"type": "API_DOC | None",
"description": "dict or None: either the matched document or None if nothing found"
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AsyncAstraDBCollection.find_one_and_update
|
Find a single document and update it.
|
{
"kind": "function",
"name": "find_one_and_update",
"path": "astrapy.core.db.AsyncAstraDBCollection.find_one_and_update",
"parameters": [
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to find the document.",
"default": "{}",
"value": "{}"
},
{
"name": "update",
"type": "dict",
"description": "The update to apply to the document.",
"default": null,
"value": null
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the operation.",
"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": "The result of the find and update operation."
}
],
"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.AsyncAstraDBCollection.vector_find_one_and_update
|
Perform a vector-based search and update the first matched document.
|
{
"kind": "function",
"name": "vector_find_one_and_update",
"path": "astrapy.core.db.AsyncAstraDBCollection.vector_find_one_and_update",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "update",
"type": "dict",
"description": "The update to apply to the matched document.",
"default": null,
"value": null
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents before applying the vector search.",
"default": "None",
"value": "None"
},
{
"name": "fields",
"type": "list",
"description": "Specifies the fields to return in the updated document.",
"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": null,
"type": "API_DOC | None",
"description": "dict or None: The result of the vector-based find and\nupdate operation, or None if nothing found"
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AsyncAstraDBCollection.find_one_and_delete
|
Find a single document and delete it.
|
{
"kind": "function",
"name": "find_one_and_delete",
"path": "astrapy.core.db.AsyncAstraDBCollection.find_one_and_delete",
"parameters": [
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to find the document.",
"default": "{}",
"value": "{}"
},
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "projection",
"type": "dict",
"description": "Specifies the fields to return.",
"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": "The result of the find and delete operation."
}
],
"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.AsyncAstraDBCollection.count_documents
|
Count documents matching a given predicate (expressed as filter).
|
{
"kind": "function",
"name": "count_documents",
"path": "astrapy.core.db.AsyncAstraDBCollection.count_documents",
"parameters": [
{
"name": "filter",
"type": "dict, defaults to {}",
"description": "Criteria to filter documents.",
"default": "{}",
"value": "{}"
},
{
"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, either\n{\"status\": {\"count\": <NUMBER> }}"
},
{
"name": null,
"type": "API_RESPONSE",
"description": "or\n{\"errors\": [...]}"
}
],
"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.AsyncAstraDBCollection.find_one
|
Find a single document in the collection.
|
{
"kind": "function",
"name": "find_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.find_one",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to filter documents.",
"default": "{}",
"value": "{}"
},
{
"name": "projection",
"type": "dict",
"description": "Specifies the fields to return.",
"default": "{}",
"value": "{}"
},
{
"name": "sort",
"type": "dict",
"description": "Specifies the order in which to return the document.",
"default": "{}",
"value": "{}"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the query.",
"default": "{}",
"value": "{}"
},
{
"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, either\n{\"data\": {\"document\": <DOCUMENT> }}"
},
{
"name": null,
"type": "API_RESPONSE",
"description": "or\n{\"data\": {\"document\": None}}"
},
{
"name": null,
"type": "API_RESPONSE",
"description": "depending on whether a matching document is found or not."
}
],
"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.AsyncAstraDBCollection.vector_find_one
|
Perform a vector-based search to find a single document in the collection.
|
{
"kind": "function",
"name": "vector_find_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.vector_find_one",
"parameters": [
{
"name": "vector",
"type": "list",
"description": "The vector to search with.",
"default": null,
"value": null
},
{
"name": "filter",
"type": "dict",
"description": "Additional criteria to filter documents.",
"default": "None",
"value": "None"
},
{
"name": "fields",
"type": "list",
"description": "Specifies the fields to return in the result.",
"default": "None",
"value": "None"
},
{
"name": "include_similarity",
"type": "bool",
"description": "Whether to include similarity score in the result.",
"default": "True",
"value": "True"
},
{
"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": null,
"type": "API_DOC | None",
"description": "dict or None: The found document or None if no matching document is found."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AsyncAstraDBCollection.insert_one
|
Insert a single document into the collection.
|
{
"kind": "function",
"name": "insert_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.insert_one",
"parameters": [
{
"name": "document",
"type": "dict",
"description": "The document to insert.",
"default": null,
"value": null
},
{
"name": "failures_allowed",
"type": "bool",
"description": "Whether to allow failures in the insert operation.",
"default": "False",
"value": "False"
},
{
"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 after the insert operation."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC",
"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.AsyncAstraDBCollection.insert_many
|
Insert multiple documents into the collection.
|
{
"kind": "function",
"name": "insert_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.insert_many",
"parameters": [
{
"name": "documents",
"type": "list",
"description": "A list of documents to insert.",
"default": null,
"value": null
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the insert operation.",
"default": "None",
"value": "None"
},
{
"name": "partial_failures_allowed",
"type": "bool",
"description": "Whether to allow partial\nfailures through the insertion (i.e. on some documents).",
"default": "False",
"value": "False"
},
{
"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 after the insert operation."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC",
"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.AsyncAstraDBCollection.chunked_insert_many
|
Insert multiple documents into the collection, handling chunking and
optionally with concurrent insertions.
|
{
"kind": "function",
"name": "chunked_insert_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.chunked_insert_many",
"parameters": [
{
"name": "documents",
"type": "list",
"description": "A list of documents to insert.",
"default": null,
"value": null
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the insert operation.",
"default": "None",
"value": "None"
},
{
"name": "partial_failures_allowed",
"type": "bool",
"description": "Whether to allow partial\nfailures in the chunk. Should be used combined with\noptions={\"ordered\": False} in most cases.",
"default": "False",
"value": "False"
},
{
"name": "chunk_size",
"type": "int",
"description": "Override the default insertion chunk size.",
"default": "DEFAULT_INSERT_NUM_DOCUMENTS",
"value": "DEFAULT_INSERT_NUM_DOCUMENTS"
},
{
"name": "concurrency",
"type": "int",
"description": "The number of concurrent chunk insertions.\nDefault is no concurrency.",
"default": "1",
"value": "1"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for each single HTTP request.\nThis method runs a number of HTTP requests as it works on chunked\ndata. The timeout refers to each individual such 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": "list",
"type": "list[API_RESPONSE | Exception]",
"description": "The responses from the database after the chunked insert operation.\nThis is a list of individual responses from the API: the caller\nwill need to inspect them all, e.g. to collate the inserted IDs."
}
],
"gathered_types": [
"astrapy.core.core_types.API_DOC",
"astrapy.core.defaults.DEFAULT_INSERT_NUM_DOCUMENTS",
"astrapy.core.core_types.API_RESPONSE",
"astrapy.core.utils.TimeoutInfoWideType",
"Exception"
],
"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.AsyncAstraDBCollection.update_one
|
Update a single document in the collection.
|
{
"kind": "function",
"name": "update_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.update_one",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "update",
"type": "dict",
"description": "The update to apply to the document.",
"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"
},
{
"name": "options",
"type": "dict",
"description": "Additional options for the operation.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": "dict",
"type": "API_RESPONSE",
"description": "The response from the database after the update operation."
}
],
"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.AsyncAstraDBCollection.update_many
|
Updates multiple documents in the collection.
|
{
"kind": "function",
"name": "update_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.update_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the document to update.",
"default": null,
"value": null
},
{
"name": "update",
"type": "dict",
"description": "The update to apply to the document.",
"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 after the update operation."
}
],
"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.AsyncAstraDBCollection.replace
|
Replace a document in the collection.
|
{
"kind": "function",
"name": "replace",
"path": "astrapy.core.db.AsyncAstraDBCollection.replace",
"parameters": [
{
"name": "path",
"type": "str",
"description": "The path to the document to replace.",
"default": null,
"value": null
},
{
"name": "document",
"type": "dict",
"description": "The new document to replace the existing one.",
"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 after the replace operation."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC",
"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.AsyncAstraDBCollection.delete_one
|
Delete a single document from the collection based on its ID.
|
{
"kind": "function",
"name": "delete_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.delete_one",
"parameters": [
{
"name": "id",
"type": "str",
"description": "The ID of the document 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 after the delete operation."
}
],
"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.AsyncAstraDBCollection.delete_one_by_predicate
|
Delete a single document from the collection based on a filter clause
|
{
"kind": "function",
"name": "delete_one_by_predicate",
"path": "astrapy.core.db.AsyncAstraDBCollection.delete_one_by_predicate",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "any filter dictionary",
"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 after the delete operation."
}
],
"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.AsyncAstraDBCollection.delete_many
|
Delete many documents from the collection based on a filter condition
|
{
"kind": "function",
"name": "delete_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.delete_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the documents to delete.",
"default": null,
"value": null
},
{
"name": "skip_error_check",
"type": "bool",
"description": "whether to ignore the check for API error\nand return the response untouched. Default is False.",
"default": "False",
"value": "False"
},
{
"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 after the delete operation."
}
],
"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.AsyncAstraDBCollection.chunked_delete_many
|
Delete many documents from the collection based on a filter condition,
chaining several API calls until exhaustion of the documents to delete.
|
{
"kind": "function",
"name": "chunked_delete_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.chunked_delete_many",
"parameters": [
{
"name": "filter",
"type": "dict",
"description": "Criteria to identify the documents to delete.",
"default": null,
"value": null
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for each single HTTP request.\nThis method runs a number of HTTP requests as it works on a\npagination basis. The timeout refers to each individual such 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": null,
"type": "list[API_RESPONSE]",
"description": "List[dict]: The responses from the database from all the calls"
}
],
"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.AsyncAstraDBCollection.clear
|
Clear the collection, deleting all documents
|
{
"kind": "function",
"name": "clear",
"path": "astrapy.core.db.AsyncAstraDBCollection.clear",
"parameters": [
{
"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.AsyncAstraDBCollection.delete_subdocument
|
Delete a subdocument or field from a document in the collection.
|
{
"kind": "function",
"name": "delete_subdocument",
"path": "astrapy.core.db.AsyncAstraDBCollection.delete_subdocument",
"parameters": [
{
"name": "id",
"type": "str",
"description": "The ID of the document containing the subdocument.",
"default": null,
"value": null
},
{
"name": "subdoc",
"type": "str",
"description": "The key of the subdocument or field to remove.",
"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 after the update operation."
}
],
"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.AsyncAstraDBCollection.upsert_one
|
Emulate an upsert operation for a single document in the collection.
This method attempts to insert the document.
If a document with the same _id exists, it updates the existing document.
|
{
"kind": "function",
"name": "upsert_one",
"path": "astrapy.core.db.AsyncAstraDBCollection.upsert_one",
"parameters": [
{
"name": "document",
"type": "dict",
"description": "The document to insert or update.",
"default": null,
"value": null
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for the HTTP requests.\nThis method may issue one or two requests, depending on what\nis detected on DB. This timeout controls each HTTP request individually.\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": "str",
"type": "str",
"description": "The _id of the inserted or updated document."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC"
],
"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.AsyncAstraDBCollection.upsert_many
|
Emulate an upsert operation for multiple documents in the collection.
This method attempts to insert the documents.
If a document with the same _id exists, it updates the existing document.
|
{
"kind": "function",
"name": "upsert_many",
"path": "astrapy.core.db.AsyncAstraDBCollection.upsert_many",
"parameters": [
{
"name": "documents",
"type": "List[dict]",
"description": "The documents to insert or update.",
"default": null,
"value": null
},
{
"name": "concurrency",
"type": "int",
"description": "The number of concurrent upserts.",
"default": "1",
"value": "1"
},
{
"name": "partial_failures_allowed",
"type": "bool",
"description": "Whether to allow partial\nfailures in the batch.",
"default": "False",
"value": "False"
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": "a float, or a TimeoutInfo dict, for each HTTP request.\nThis method issues a separate HTTP request for each document to\ninsert: the timeout controls each such request individually.\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": null,
"type": "list[str | Exception]",
"description": "List[Union[str, Exception]]: A list of \"_id\"s of the inserted or updated documents."
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.core.core_types.API_DOC",
"Exception"
],
"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
|
{
"kind": "class",
"name": "AstraDB",
"path": "astrapy.core.db.AstraDB",
"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.AstraDB.client
|
{
"kind": "attribute",
"name": "client",
"path": "astrapy.core.db.AstraDB.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.db.AstraDB.caller_name
|
{
"kind": "attribute",
"name": "caller_name",
"path": "astrapy.core.db.AstraDB.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
}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.