id
stringlengths 7
77
| text
stringlengths 0
3.4k
| metadata
dict |
|---|---|---|
astrapy.exceptions.MultiCallTimeoutManager.remaining_timeout_ms
|
Ensure the deadline, if any, is not yet in the past.
If it is, raise an appropriate timeout error.
If not, return either None (if no timeout) or the remaining milliseconds.
For use within the multi-call method.
|
{
"kind": "function",
"name": "remaining_timeout_ms",
"path": "astrapy.exceptions.MultiCallTimeoutManager.remaining_timeout_ms",
"parameters": null,
"returns": [
{
"name": null,
"type": "int | 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.exceptions.MultiCallTimeoutManager.remaining_timeout_info
|
Ensure the deadline, if any, is not yet in the past.
If it is, raise an appropriate timeout error.
It it is not, or there is no deadline, return a suitable TimeoutInfo
for use within the multi-call method.
|
{
"kind": "function",
"name": "remaining_timeout_info",
"path": "astrapy.exceptions.MultiCallTimeoutManager.remaining_timeout_info",
"parameters": null,
"returns": [
{
"name": null,
"type": "TimeoutInfo | None",
"description": null
}
],
"gathered_types": [
"astrapy.request_tools.TimeoutInfo"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.defaults
|
{
"kind": "module",
"name": "defaults",
"path": "astrapy.defaults",
"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": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": null,
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": null,
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": false,
"is_package": false,
"is_subpackage": false,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DATA_API_ENVIRONMENT_PROD
|
{
"kind": "attribute",
"name": "DATA_API_ENVIRONMENT_PROD",
"path": "astrapy.defaults.DATA_API_ENVIRONMENT_PROD",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DATA_API_ENVIRONMENT_PROD = 'prod'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DATA_API_ENVIRONMENT_DEV
|
{
"kind": "attribute",
"name": "DATA_API_ENVIRONMENT_DEV",
"path": "astrapy.defaults.DATA_API_ENVIRONMENT_DEV",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DATA_API_ENVIRONMENT_DEV = 'dev'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DATA_API_ENVIRONMENT_TEST
|
{
"kind": "attribute",
"name": "DATA_API_ENVIRONMENT_TEST",
"path": "astrapy.defaults.DATA_API_ENVIRONMENT_TEST",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DATA_API_ENVIRONMENT_TEST = 'test'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DATA_API_ENVIRONMENT_DSE
|
{
"kind": "attribute",
"name": "DATA_API_ENVIRONMENT_DSE",
"path": "astrapy.defaults.DATA_API_ENVIRONMENT_DSE",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DATA_API_ENVIRONMENT_DSE = 'dse'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DATA_API_ENVIRONMENT_HCD
|
{
"kind": "attribute",
"name": "DATA_API_ENVIRONMENT_HCD",
"path": "astrapy.defaults.DATA_API_ENVIRONMENT_HCD",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DATA_API_ENVIRONMENT_HCD = 'hcd'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DATA_API_ENVIRONMENT_CASSANDRA
|
{
"kind": "attribute",
"name": "DATA_API_ENVIRONMENT_CASSANDRA",
"path": "astrapy.defaults.DATA_API_ENVIRONMENT_CASSANDRA",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DATA_API_ENVIRONMENT_CASSANDRA = 'cassandra'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DATA_API_ENVIRONMENT_OTHER
|
{
"kind": "attribute",
"name": "DATA_API_ENVIRONMENT_OTHER",
"path": "astrapy.defaults.DATA_API_ENVIRONMENT_OTHER",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DATA_API_ENVIRONMENT_OTHER = 'other'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEFAULT_ASTRA_DB_KEYSPACE
|
{
"kind": "attribute",
"name": "DEFAULT_ASTRA_DB_KEYSPACE",
"path": "astrapy.defaults.DEFAULT_ASTRA_DB_KEYSPACE",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_ASTRA_DB_KEYSPACE = 'default_keyspace'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.API_ENDPOINT_TEMPLATE_ENV_MAP
|
{
"kind": "attribute",
"name": "API_ENDPOINT_TEMPLATE_ENV_MAP",
"path": "astrapy.defaults.API_ENDPOINT_TEMPLATE_ENV_MAP",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.defaults.DATA_API_ENVIRONMENT_PROD",
"astrapy.defaults.DATA_API_ENVIRONMENT_DEV",
"astrapy.defaults.DATA_API_ENVIRONMENT_TEST"
],
"value": "API_ENDPOINT_TEMPLATE_ENV_MAP = {DATA_API_ENVIRONMENT_PROD: 'https://{database_id}-{region}.apps.astra.datastax.com', DATA_API_ENVIRONMENT_DEV: 'https://{database_id}-{region}.apps.astra-dev.datastax.com', DATA_API_ENVIRONMENT_TEST: 'https://{database_id}-{region}.apps.astra-test.datastax.com'}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.API_PATH_ENV_MAP
|
{
"kind": "attribute",
"name": "API_PATH_ENV_MAP",
"path": "astrapy.defaults.API_PATH_ENV_MAP",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.defaults.DATA_API_ENVIRONMENT_DEV",
"astrapy.defaults.DATA_API_ENVIRONMENT_TEST",
"astrapy.defaults.DATA_API_ENVIRONMENT_DSE",
"astrapy.defaults.DATA_API_ENVIRONMENT_CASSANDRA",
"astrapy.defaults.DATA_API_ENVIRONMENT_OTHER",
"astrapy.defaults.DATA_API_ENVIRONMENT_PROD",
"astrapy.defaults.DATA_API_ENVIRONMENT_HCD"
],
"value": "API_PATH_ENV_MAP = {DATA_API_ENVIRONMENT_PROD: '/api/json', DATA_API_ENVIRONMENT_DEV: '/api/json', DATA_API_ENVIRONMENT_TEST: '/api/json', DATA_API_ENVIRONMENT_DSE: '', DATA_API_ENVIRONMENT_HCD: '', DATA_API_ENVIRONMENT_CASSANDRA: '', DATA_API_ENVIRONMENT_OTHER: ''}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.API_VERSION_ENV_MAP
|
{
"kind": "attribute",
"name": "API_VERSION_ENV_MAP",
"path": "astrapy.defaults.API_VERSION_ENV_MAP",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.defaults.DATA_API_ENVIRONMENT_DEV",
"astrapy.defaults.DATA_API_ENVIRONMENT_TEST",
"astrapy.defaults.DATA_API_ENVIRONMENT_DSE",
"astrapy.defaults.DATA_API_ENVIRONMENT_CASSANDRA",
"astrapy.defaults.DATA_API_ENVIRONMENT_OTHER",
"astrapy.defaults.DATA_API_ENVIRONMENT_PROD",
"astrapy.defaults.DATA_API_ENVIRONMENT_HCD"
],
"value": "API_VERSION_ENV_MAP = {DATA_API_ENVIRONMENT_PROD: '/v1', DATA_API_ENVIRONMENT_DEV: '/v1', DATA_API_ENVIRONMENT_TEST: '/v1', DATA_API_ENVIRONMENT_DSE: 'v1', DATA_API_ENVIRONMENT_HCD: 'v1', DATA_API_ENVIRONMENT_CASSANDRA: 'v1', DATA_API_ENVIRONMENT_OTHER: 'v1'}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEFAULT_INSERT_MANY_CHUNK_SIZE
|
{
"kind": "attribute",
"name": "DEFAULT_INSERT_MANY_CHUNK_SIZE",
"path": "astrapy.defaults.DEFAULT_INSERT_MANY_CHUNK_SIZE",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_INSERT_MANY_CHUNK_SIZE = 50",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEFAULT_INSERT_MANY_CONCURRENCY
|
{
"kind": "attribute",
"name": "DEFAULT_INSERT_MANY_CONCURRENCY",
"path": "astrapy.defaults.DEFAULT_INSERT_MANY_CONCURRENCY",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_INSERT_MANY_CONCURRENCY = 20",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEFAULT_BULK_WRITE_CONCURRENCY
|
{
"kind": "attribute",
"name": "DEFAULT_BULK_WRITE_CONCURRENCY",
"path": "astrapy.defaults.DEFAULT_BULK_WRITE_CONCURRENCY",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_BULK_WRITE_CONCURRENCY = 10",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEFAULT_REQUEST_TIMEOUT_MS
|
{
"kind": "attribute",
"name": "DEFAULT_REQUEST_TIMEOUT_MS",
"path": "astrapy.defaults.DEFAULT_REQUEST_TIMEOUT_MS",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_REQUEST_TIMEOUT_MS = 30000",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEFAULT_DATA_API_AUTH_HEADER
|
{
"kind": "attribute",
"name": "DEFAULT_DATA_API_AUTH_HEADER",
"path": "astrapy.defaults.DEFAULT_DATA_API_AUTH_HEADER",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_DATA_API_AUTH_HEADER = 'Token'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.EMBEDDING_HEADER_AWS_ACCESS_ID
|
{
"kind": "attribute",
"name": "EMBEDDING_HEADER_AWS_ACCESS_ID",
"path": "astrapy.defaults.EMBEDDING_HEADER_AWS_ACCESS_ID",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "EMBEDDING_HEADER_AWS_ACCESS_ID = 'X-Embedding-Access-Id'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.EMBEDDING_HEADER_AWS_SECRET_ID
|
{
"kind": "attribute",
"name": "EMBEDDING_HEADER_AWS_SECRET_ID",
"path": "astrapy.defaults.EMBEDDING_HEADER_AWS_SECRET_ID",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "EMBEDDING_HEADER_AWS_SECRET_ID = 'X-Embedding-Secret-Id'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.EMBEDDING_HEADER_API_KEY
|
{
"kind": "attribute",
"name": "EMBEDDING_HEADER_API_KEY",
"path": "astrapy.defaults.EMBEDDING_HEADER_API_KEY",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "EMBEDDING_HEADER_API_KEY = 'X-Embedding-Api-Key'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEFAULT_DEV_OPS_AUTH_HEADER
|
{
"kind": "attribute",
"name": "DEFAULT_DEV_OPS_AUTH_HEADER",
"path": "astrapy.defaults.DEFAULT_DEV_OPS_AUTH_HEADER",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_DEV_OPS_AUTH_HEADER = 'Authorization'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEFAULT_DEV_OPS_AUTH_PREFIX
|
{
"kind": "attribute",
"name": "DEFAULT_DEV_OPS_AUTH_PREFIX",
"path": "astrapy.defaults.DEFAULT_DEV_OPS_AUTH_PREFIX",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEFAULT_DEV_OPS_AUTH_PREFIX = 'Bearer '",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_KEYSPACE_POLL_INTERVAL_S
|
{
"kind": "attribute",
"name": "DEV_OPS_KEYSPACE_POLL_INTERVAL_S",
"path": "astrapy.defaults.DEV_OPS_KEYSPACE_POLL_INTERVAL_S",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEV_OPS_KEYSPACE_POLL_INTERVAL_S = 2",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_DATABASE_POLL_INTERVAL_S
|
{
"kind": "attribute",
"name": "DEV_OPS_DATABASE_POLL_INTERVAL_S",
"path": "astrapy.defaults.DEV_OPS_DATABASE_POLL_INTERVAL_S",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEV_OPS_DATABASE_POLL_INTERVAL_S = 15",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_DATABASE_STATUS_MAINTENANCE
|
{
"kind": "attribute",
"name": "DEV_OPS_DATABASE_STATUS_MAINTENANCE",
"path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_MAINTENANCE",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEV_OPS_DATABASE_STATUS_MAINTENANCE = 'MAINTENANCE'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_DATABASE_STATUS_ACTIVE
|
{
"kind": "attribute",
"name": "DEV_OPS_DATABASE_STATUS_ACTIVE",
"path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_ACTIVE",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEV_OPS_DATABASE_STATUS_ACTIVE = 'ACTIVE'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_DATABASE_STATUS_PENDING
|
{
"kind": "attribute",
"name": "DEV_OPS_DATABASE_STATUS_PENDING",
"path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_PENDING",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEV_OPS_DATABASE_STATUS_PENDING = 'PENDING'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_DATABASE_STATUS_INITIALIZING
|
{
"kind": "attribute",
"name": "DEV_OPS_DATABASE_STATUS_INITIALIZING",
"path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_INITIALIZING",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEV_OPS_DATABASE_STATUS_INITIALIZING = 'INITIALIZING'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_DATABASE_STATUS_ERROR
|
{
"kind": "attribute",
"name": "DEV_OPS_DATABASE_STATUS_ERROR",
"path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_ERROR",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEV_OPS_DATABASE_STATUS_ERROR = 'ERROR'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_DATABASE_STATUS_TERMINATING
|
{
"kind": "attribute",
"name": "DEV_OPS_DATABASE_STATUS_TERMINATING",
"path": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_TERMINATING",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEV_OPS_DATABASE_STATUS_TERMINATING = 'TERMINATING'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_URL_ENV_MAP
|
{
"kind": "attribute",
"name": "DEV_OPS_URL_ENV_MAP",
"path": "astrapy.defaults.DEV_OPS_URL_ENV_MAP",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.defaults.DATA_API_ENVIRONMENT_PROD",
"astrapy.defaults.DATA_API_ENVIRONMENT_DEV",
"astrapy.defaults.DATA_API_ENVIRONMENT_TEST"
],
"value": "DEV_OPS_URL_ENV_MAP = {DATA_API_ENVIRONMENT_PROD: 'https://api.astra.datastax.com', DATA_API_ENVIRONMENT_DEV: 'https://api.dev.cloud.datastax.com', DATA_API_ENVIRONMENT_TEST: 'https://api.test.cloud.datastax.com'}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_VERSION_ENV_MAP
|
{
"kind": "attribute",
"name": "DEV_OPS_VERSION_ENV_MAP",
"path": "astrapy.defaults.DEV_OPS_VERSION_ENV_MAP",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.defaults.DATA_API_ENVIRONMENT_PROD",
"astrapy.defaults.DATA_API_ENVIRONMENT_DEV",
"astrapy.defaults.DATA_API_ENVIRONMENT_TEST"
],
"value": "DEV_OPS_VERSION_ENV_MAP = {DATA_API_ENVIRONMENT_PROD: 'v2', DATA_API_ENVIRONMENT_DEV: 'v2', DATA_API_ENVIRONMENT_TEST: 'v2'}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_RESPONSE_HTTP_ACCEPTED
|
{
"kind": "attribute",
"name": "DEV_OPS_RESPONSE_HTTP_ACCEPTED",
"path": "astrapy.defaults.DEV_OPS_RESPONSE_HTTP_ACCEPTED",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEV_OPS_RESPONSE_HTTP_ACCEPTED = 202",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_RESPONSE_HTTP_CREATED
|
{
"kind": "attribute",
"name": "DEV_OPS_RESPONSE_HTTP_CREATED",
"path": "astrapy.defaults.DEV_OPS_RESPONSE_HTTP_CREATED",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEV_OPS_RESPONSE_HTTP_CREATED = 201",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE
|
{
"kind": "attribute",
"name": "DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE",
"path": "astrapy.defaults.DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE = 25",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.SECRETS_REDACT_ENDING
|
{
"kind": "attribute",
"name": "SECRETS_REDACT_ENDING",
"path": "astrapy.defaults.SECRETS_REDACT_ENDING",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "SECRETS_REDACT_ENDING = '...'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.SECRETS_REDACT_CHAR
|
{
"kind": "attribute",
"name": "SECRETS_REDACT_CHAR",
"path": "astrapy.defaults.SECRETS_REDACT_CHAR",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "SECRETS_REDACT_CHAR = '*'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.SECRETS_REDACT_ENDING_LENGTH
|
{
"kind": "attribute",
"name": "SECRETS_REDACT_ENDING_LENGTH",
"path": "astrapy.defaults.SECRETS_REDACT_ENDING_LENGTH",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "SECRETS_REDACT_ENDING_LENGTH = 3",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.HEADER_REDACT_PLACEHOLDER
|
{
"kind": "attribute",
"name": "HEADER_REDACT_PLACEHOLDER",
"path": "astrapy.defaults.HEADER_REDACT_PLACEHOLDER",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "HEADER_REDACT_PLACEHOLDER = '***'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.DEFAULT_REDACTED_HEADER_NAMES
|
{
"kind": "attribute",
"name": "DEFAULT_REDACTED_HEADER_NAMES",
"path": "astrapy.defaults.DEFAULT_REDACTED_HEADER_NAMES",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.defaults.EMBEDDING_HEADER_API_KEY",
"astrapy.defaults.EMBEDDING_HEADER_AWS_SECRET_ID",
"astrapy.defaults.DEFAULT_DATA_API_AUTH_HEADER",
"astrapy.defaults.EMBEDDING_HEADER_AWS_ACCESS_ID",
"astrapy.core.defaults.DEFAULT_DEV_OPS_AUTH_HEADER"
],
"value": "DEFAULT_REDACTED_HEADER_NAMES = {DEFAULT_DATA_API_AUTH_HEADER, DEFAULT_DEV_OPS_AUTH_HEADER, EMBEDDING_HEADER_AWS_ACCESS_ID, EMBEDDING_HEADER_AWS_SECRET_ID, EMBEDDING_HEADER_API_KEY}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_METHOD
|
{
"kind": "attribute",
"name": "NAMESPACE_DEPRECATION_NOTICE_METHOD",
"path": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_METHOD",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "NAMESPACE_DEPRECATION_NOTICE_METHOD = \"The term 'namespace' is being replaced by 'keyspace' throughout the Data API and the clients. Please adapt method and parameter names consistently (examples: `db_admin.findNamespaces` => `db_admin.findKeyspaces`; `collection.namespace` => `collection.keyspace`; `database.list_collections(namespace=...)` => `database.list_collections(keyspace=...)`). See https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5 for more information.\"",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT
|
{
"kind": "attribute",
"name": "NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT",
"path": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT = 'Parameter `update_db_namespace`'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS
|
{
"kind": "attribute",
"name": "NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS",
"path": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS = 'Please replace the parameter with `update_db_keyspace`. See https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5 for more information.'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT
|
{
"kind": "attribute",
"name": "NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT",
"path": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT = 'Parameter `namespace`'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS
|
{
"kind": "attribute",
"name": "NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS",
"path": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS = 'Please replace the parameter with `keyspace`. See https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5 for more information.'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.SET_CALLER_DEPRECATION_NOTICE
|
{
"kind": "attribute",
"name": "SET_CALLER_DEPRECATION_NOTICE",
"path": "astrapy.defaults.SET_CALLER_DEPRECATION_NOTICE",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "SET_CALLER_DEPRECATION_NOTICE = 'Please provide the caller(s) at constructor time through the `callers` list parameter.'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.defaults.CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS
|
{
"kind": "attribute",
"name": "CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS",
"path": "astrapy.defaults.CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS = \"Please pass any caller identities as the `callers` constructor parameter: `callers=[('cname1', 'cversion1'), ('cname2', 'cversion2'), ...]`.\"",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.ids
|
{
"kind": "module",
"name": "ids",
"path": "astrapy.ids",
"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": "uuid.UUID",
"ObjectId": "bson.objectid.ObjectId",
"uuid1": "uuid.uuid1",
"uuid3": "uuid.uuid3",
"uuid4": "uuid.uuid4",
"uuid5": "uuid.uuid5",
"uuid6": "uuid6.uuid6",
"uuid7": "uuid6.uuid7",
"uuid8": "uuid6.uuid8",
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": null,
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": null,
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": null,
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": false,
"is_package": false,
"is_subpackage": false,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": [
"uuid6",
"uuid4",
"uuid1",
"uuid7",
"UUID",
"ObjectId",
"uuid3",
"uuid8",
"uuid5"
],
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.user_agents
|
{
"kind": "module",
"name": "user_agents",
"path": "astrapy.user_agents",
"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__": "astrapy.__version__",
"DEFAULT_REDACTED_HEADERS": null,
"DEFAULT_TIMEOUT": null,
"UUID": null,
"ObjectId": null,
"uuid1": null,
"uuid3": null,
"uuid4": null,
"uuid5": null,
"uuid6": null,
"uuid7": null,
"uuid8": null,
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": null,
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": null,
"Sequence": "typing.Sequence",
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": "astrapy.constants.CallerType",
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": null,
"Database": null,
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": null,
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": null,
"SET_CALLER_DEPRECATION_NOTICE": null,
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": null,
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": null,
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": null,
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": null,
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": null,
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": null,
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": false,
"is_package": false,
"is_subpackage": false,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.user_agents.detect_astrapy_user_agent
|
{
"kind": "function",
"name": "detect_astrapy_user_agent",
"path": "astrapy.user_agents.detect_astrapy_user_agent",
"parameters": null,
"returns": [
{
"name": null,
"type": "CallerType",
"description": null
}
],
"gathered_types": [
"astrapy.constants.CallerType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.user_agents.compose_user_agent_string
|
{
"kind": "function",
"name": "compose_user_agent_string",
"path": "astrapy.user_agents.compose_user_agent_string",
"parameters": [
{
"name": "caller_name",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "caller_version",
"type": "str | None",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "str | 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.user_agents.compose_full_user_agent
|
{
"kind": "function",
"name": "compose_full_user_agent",
"path": "astrapy.user_agents.compose_full_user_agent",
"parameters": [
{
"name": "callers",
"type": "Sequence[CallerType]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "str | None",
"description": null
}
],
"gathered_types": [
"astrapy.constants.CallerType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander
|
{
"kind": "module",
"name": "api_commander",
"path": "astrapy.api_commander",
"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": 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": "astrapy.request_tools.TimeoutInfoWideType",
"http_methods": null,
"to_httpx_timeout": "astrapy.request_tools.to_httpx_timeout",
"Dict": "typing.Dict",
"List": null,
"Protocol": null,
"Union": null,
"datetime": null,
"json": "json",
"time": null,
"Iterable": "typing.Iterable",
"__version__": null,
"DEFAULT_REDACTED_HEADERS": null,
"DEFAULT_TIMEOUT": null,
"UUID": null,
"ObjectId": null,
"uuid1": null,
"uuid3": null,
"uuid4": null,
"uuid5": null,
"uuid6": null,
"uuid7": null,
"uuid8": null,
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": null,
"asyncio": null,
"warnings": null,
"ThreadPoolExecutor": null,
"TracebackType": "types.TracebackType",
"TYPE_CHECKING": "typing.TYPE_CHECKING",
"Sequence": "typing.Sequence",
"deprecation": null,
"APICommander": null,
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": "astrapy.constants.CallerType",
"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": "astrapy.exceptions.DataAPIFaultyResponseException",
"DataAPIResponseException": "astrapy.exceptions.DataAPIResponseException",
"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": "astrapy.defaults.DEFAULT_REDACTED_HEADER_NAMES",
"DEFAULT_REQUEST_TIMEOUT_MS": "astrapy.defaults.DEFAULT_REQUEST_TIMEOUT_MS",
"HEADER_REDACT_PLACEHOLDER": "astrapy.defaults.HEADER_REDACT_PLACEHOLDER",
"DataAPIHttpException": "astrapy.exceptions.DataAPIHttpException",
"DevOpsAPIFaultyResponseException": "astrapy.exceptions.DevOpsAPIFaultyResponseException",
"DevOpsAPIHttpException": "astrapy.exceptions.DevOpsAPIHttpException",
"DevOpsAPIResponseException": "astrapy.exceptions.DevOpsAPIResponseException",
"to_dataapi_timeout_exception": "astrapy.exceptions.to_dataapi_timeout_exception",
"to_devopsapi_timeout_exception": "astrapy.exceptions.to_devopsapi_timeout_exception",
"HttpMethod": "astrapy.request_tools.HttpMethod",
"log_httpx_request": "astrapy.request_tools.log_httpx_request",
"log_httpx_response": "astrapy.request_tools.log_httpx_response",
"normalize_for_api": "astrapy.transform_payload.normalize_for_api",
"restore_from_api": "astrapy.transform_payload.restore_from_api",
"compose_full_user_agent": "astrapy.user_agents.compose_full_user_agent",
"detect_astrapy_user_agent": "astrapy.user_agents.detect_astrapy_user_agent",
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": false,
"is_package": false,
"is_subpackage": false,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.user_agent_astrapy
|
{
"kind": "attribute",
"name": "user_agent_astrapy",
"path": "astrapy.api_commander.user_agent_astrapy",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "user_agent_astrapy = detect_astrapy_user_agent()",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.logger
|
{
"kind": "attribute",
"name": "logger",
"path": "astrapy.api_commander.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.api_commander.APICommander
|
{
"kind": "class",
"name": "APICommander",
"path": "astrapy.api_commander.APICommander",
"parameters": [
{
"name": "api_endpoint",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "path",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "headers",
"type": "dict[str, str | None]",
"description": null,
"default": "{}",
"value": null
},
{
"name": "callers",
"type": "Sequence[CallerType]",
"description": null,
"default": "[]",
"value": null
},
{
"name": "redacted_header_names",
"type": "Iterable[str]",
"description": null,
"default": "DEFAULT_REDACTED_HEADER_NAMES",
"value": null
},
{
"name": "dev_ops_api",
"type": "bool",
"description": null,
"default": "False",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.defaults.DEFAULT_REDACTED_HEADER_NAMES",
"astrapy.constants.CallerType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.client
|
{
"kind": "attribute",
"name": "client",
"path": "astrapy.api_commander.APICommander.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.api_commander.APICommander.async_client
|
{
"kind": "attribute",
"name": "async_client",
"path": "astrapy.api_commander.APICommander.async_client",
"parameters": null,
"returns": null,
"gathered_types": [
"AsyncClient"
],
"value": "async_client = httpx.AsyncClient()",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.api_endpoint
|
{
"kind": "attribute",
"name": "api_endpoint",
"path": "astrapy.api_commander.APICommander.api_endpoint",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "api_endpoint = api_endpoint.rstrip('/')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.path
|
{
"kind": "attribute",
"name": "path",
"path": "astrapy.api_commander.APICommander.path",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "path = path.lstrip('/')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.headers
|
{
"kind": "attribute",
"name": "headers",
"path": "astrapy.api_commander.APICommander.headers",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "headers = headers",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.callers
|
{
"kind": "attribute",
"name": "callers",
"path": "astrapy.api_commander.APICommander.callers",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "callers = callers",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.redacted_header_names
|
{
"kind": "attribute",
"name": "redacted_header_names",
"path": "astrapy.api_commander.APICommander.redacted_header_names",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "redacted_header_names = set(redacted_header_names)",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.dev_ops_api
|
{
"kind": "attribute",
"name": "dev_ops_api",
"path": "astrapy.api_commander.APICommander.dev_ops_api",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "dev_ops_api = dev_ops_api",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.caller_header
|
{
"kind": "attribute",
"name": "caller_header",
"path": "astrapy.api_commander.APICommander.caller_header",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "caller_header: dict[str, str] = {'User-Agent': full_user_agent_string} if full_user_agent_string else {}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.full_headers
|
{
"kind": "attribute",
"name": "full_headers",
"path": "astrapy.api_commander.APICommander.full_headers",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "full_headers: dict[str, str] = {None: {k: vfor (k, v) in self.headers.items() if v is not None}, None: self.caller_header, None: {'Content-Type': 'application/json'}}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.full_path
|
{
"kind": "attribute",
"name": "full_path",
"path": "astrapy.api_commander.APICommander.full_path",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "full_path = '/'.join([self.api_endpoint, self.path]).rstrip('/')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.raw_request
|
{
"kind": "function",
"name": "raw_request",
"path": "astrapy.api_commander.APICommander.raw_request",
"parameters": [
{
"name": "http_method",
"type": "str",
"description": null,
"default": "HttpMethod.POST",
"value": null
},
{
"name": "payload",
"type": "dict[str, Any] | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "additional_path",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "request_params",
"type": "dict[str, Any]",
"description": null,
"default": "{}",
"value": null
},
{
"name": "raise_api_errors",
"type": "bool",
"description": null,
"default": "True",
"value": null
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "httpx.Response",
"description": null
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.request_tools.HttpMethod",
"POST",
"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.api_commander.APICommander.async_raw_request
|
{
"kind": "function",
"name": "async_raw_request",
"path": "astrapy.api_commander.APICommander.async_raw_request",
"parameters": [
{
"name": "http_method",
"type": "str",
"description": null,
"default": "HttpMethod.POST",
"value": null
},
{
"name": "payload",
"type": "dict[str, Any] | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "additional_path",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "request_params",
"type": "dict[str, Any]",
"description": null,
"default": "{}",
"value": null
},
{
"name": "raise_api_errors",
"type": "bool",
"description": null,
"default": "True",
"value": null
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "httpx.Response",
"description": null
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.request_tools.HttpMethod",
"POST",
"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.api_commander.APICommander.request
|
{
"kind": "function",
"name": "request",
"path": "astrapy.api_commander.APICommander.request",
"parameters": [
{
"name": "http_method",
"type": "str",
"description": null,
"default": "HttpMethod.POST",
"value": null
},
{
"name": "payload",
"type": "dict[str, Any] | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "additional_path",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "request_params",
"type": "dict[str, Any]",
"description": null,
"default": "{}",
"value": null
},
{
"name": "raise_api_errors",
"type": "bool",
"description": null,
"default": "True",
"value": null
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"description": null
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.request_tools.HttpMethod",
"POST"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.api_commander.APICommander.async_request
|
{
"kind": "function",
"name": "async_request",
"path": "astrapy.api_commander.APICommander.async_request",
"parameters": [
{
"name": "http_method",
"type": "str",
"description": null,
"default": "HttpMethod.POST",
"value": null
},
{
"name": "payload",
"type": "dict[str, Any] | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "additional_path",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "request_params",
"type": "dict[str, Any]",
"description": null,
"default": "{}",
"value": null
},
{
"name": "raise_api_errors",
"type": "bool",
"description": null,
"default": "True",
"value": null
},
{
"name": "timeout_info",
"type": "TimeoutInfoWideType",
"description": null,
"default": "None",
"value": null
}
],
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"description": null
}
],
"gathered_types": [
"astrapy.core.utils.TimeoutInfoWideType",
"astrapy.request_tools.HttpMethod",
"POST"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info
|
{
"kind": "module",
"name": "info",
"path": "astrapy.info",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": null,
"Any": "typing.Any",
"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": "dataclasses.dataclass",
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": null,
"log_httpx_request": null,
"log_httpx_response": null,
"normalize_for_api": null,
"restore_from_api": null,
"compose_full_user_agent": null,
"detect_astrapy_user_agent": null,
"DeprecatedWarning": null,
"CALLER_NAME_VERSION_DEPRECATION_NOTICE_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_NS_SUBJECT": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_DETAILS": null,
"NAMESPACE_DEPRECATION_NOTICE_UPDATEDBNS_SUBJECT": null,
"inspect": null,
"queue": null,
"threading": null,
"weakref": null,
"AsyncGenerator": null,
"AsyncIterator": null,
"partial": null,
"Callable": null,
"Iterator": null,
"API_DOC": null,
"AsyncPaginableRequestMethod": null,
"PaginableRequestMethod": null,
"DEFAULT_AUTH_HEADER": null,
"DEFAULT_INSERT_NUM_DOCUMENTS": null,
"DEFAULT_JSON_API_PATH": null,
"DEFAULT_JSON_API_VERSION": null,
"DEFAULT_KEYSPACE_NAME": null,
"convert_vector_to_floats": null,
"make_payload": null,
"importlib": null,
"os": null,
"toml": null,
"astrapy": null,
"AstraDBAdmin": null,
"AstraDBDatabaseAdmin": null,
"DataAPIDatabaseAdmin": null,
"DataAPIClient": null,
"AsyncCollection": null,
"Collection": null,
"field": null,
"TypeVar": null,
"EmbeddingAPIKeyHeaderProvider": null,
"ABC": null,
"abstractmethod": null,
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": null,
"redact_secret": null,
"Environment": null,
"AsyncCommandCursor": null,
"CommandCursor": null,
"API_PATH_ENV_MAP": null,
"API_VERSION_ENV_MAP": null,
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": null,
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": null,
"DatabaseAdmin": null,
"TokenProvider": null,
"api_endpoint_parsing_error_message": null,
"build_api_endpoint": null,
"check_id_endpoint_parg_kwargs": null,
"generic_api_url_parsing_error_message": null,
"normalize_region_for_id": null,
"parse_generic_api_url": null,
"check_deprecated_id_region": null,
"hashlib": null,
"Enum": null,
"Generic": null,
"Optional": null,
"Tuple": null,
"CursorIsStartedException": null,
"DataAPITimeoutException": null,
"normalize_payload_value": null,
"DATA_API_ENVIRONMENT_CASSANDRA": null,
"DATA_API_ENVIRONMENT_DEV": null,
"DATA_API_ENVIRONMENT_DSE": null,
"DATA_API_ENVIRONMENT_HCD": null,
"DATA_API_ENVIRONMENT_OTHER": null,
"DATA_API_ENVIRONMENT_PROD": null,
"DATA_API_ENVIRONMENT_TEST": null,
"reduce": null,
"re": null,
"API_ENDPOINT_TEMPLATE_ENV_MAP": null,
"DEFAULT_DEV_OPS_AUTH_PREFIX": null,
"DEV_OPS_DATABASE_POLL_INTERVAL_S": null,
"DEV_OPS_DATABASE_STATUS_ACTIVE": null,
"DEV_OPS_DATABASE_STATUS_INITIALIZING": null,
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": null,
"DEV_OPS_DATABASE_STATUS_PENDING": null,
"DEV_OPS_DATABASE_STATUS_TERMINATING": null,
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": null,
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": null,
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": null,
"DEV_OPS_RESPONSE_HTTP_CREATED": null,
"DEV_OPS_URL_ENV_MAP": null,
"DEV_OPS_VERSION_ENV_MAP": null,
"AdminDatabaseInfo": null,
"FindEmbeddingProvidersResult": null,
"check_update_db_namespace_keyspace": null,
"base64": null,
"EMBEDDING_HEADER_API_KEY": null,
"EMBEDDING_HEADER_AWS_ACCESS_ID": null,
"EMBEDDING_HEADER_AWS_SECRET_ID": null,
"SECRETS_REDACT_CHAR": null,
"SECRETS_REDACT_ENDING": null,
"SECRETS_REDACT_ENDING_LENGTH": null
},
"properties": {
"is_init_module": false,
"is_package": false,
"is_subpackage": false,
"is_namespace_package": false,
"is_namespace_subpackage": false
},
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.DatabaseInfo
|
Represents the identifying information for a database,
including the region the connection is established to.
|
{
"kind": "class",
"name": "DatabaseInfo",
"path": "astrapy.info.DatabaseInfo",
"parameters": [
{
"name": "id",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "region",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "keyspace",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "namespace",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "name",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "environment",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_info",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": "The `raw_info` dictionary usually has a `region` key describing\nthe default region as configured in the database, which does not\nnecessarily (for multi-region databases) match the region through\nwhich the connection is established: the latter is the one specified\nby the \"api endpoint\" used for connecting. In other words, for multi-region\ndatabases it is possible that\n database_info.region != database_info.raw_info[\"region\"]\nConversely, in case of a DatabaseInfo not obtained through a\nconnected database, such as when calling `Admin.list_databases()`,\nall fields except `environment` (e.g. keyspace, region, etc)\nare set as found on the DevOps API response directly.",
"implemented_by": null,
"attributes": [
{
"name": "id",
"type": "str",
"description": "the database ID."
},
{
"name": "region",
"type": "str",
"description": "the ID of the region through which the connection to DB is done."
},
{
"name": "keyspace",
"type": "str | None",
"description": "the namespace this DB is set to work with. None if not set."
},
{
"name": "namespace",
"type": "str | None",
"description": "an alias for 'keyspace'. *DEPRECATED*, removal in 2.0"
},
{
"name": "name",
"type": "str",
"description": "the database name. Not necessarily unique: there can be multiple\ndatabases with the same name."
},
{
"name": "environment",
"type": "str",
"description": "a label, whose value can be `Environment.PROD`,\nor another value in `Environment.*`."
},
{
"name": "raw_info",
"type": "dict[str, Any] | None",
"description": "the full response from the DevOPS API call to get this info."
}
]
}
|
astrapy.info.DatabaseInfo.id
|
{
"kind": "attribute",
"name": "id",
"path": "astrapy.info.DatabaseInfo.id",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "id: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.DatabaseInfo.region
|
{
"kind": "attribute",
"name": "region",
"path": "astrapy.info.DatabaseInfo.region",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "region: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.DatabaseInfo.keyspace
|
{
"kind": "attribute",
"name": "keyspace",
"path": "astrapy.info.DatabaseInfo.keyspace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "keyspace: str | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.DatabaseInfo.namespace
|
{
"kind": "attribute",
"name": "namespace",
"path": "astrapy.info.DatabaseInfo.namespace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "namespace: str | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.DatabaseInfo.name
|
{
"kind": "attribute",
"name": "name",
"path": "astrapy.info.DatabaseInfo.name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "name: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.DatabaseInfo.environment
|
{
"kind": "attribute",
"name": "environment",
"path": "astrapy.info.DatabaseInfo.environment",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "environment: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.DatabaseInfo.raw_info
|
{
"kind": "attribute",
"name": "raw_info",
"path": "astrapy.info.DatabaseInfo.raw_info",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_info: dict[str, Any] | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo
|
Represents the full response from the DevOps API about a database info.
Most attributes just contain the corresponding part of the raw response:
for this reason, please consult the DevOps API documentation for details.
|
{
"kind": "class",
"name": "AdminDatabaseInfo",
"path": "astrapy.info.AdminDatabaseInfo",
"parameters": [
{
"name": "info",
"type": "DatabaseInfo",
"description": null,
"default": null,
"value": null
},
{
"name": "available_actions",
"type": "list[str] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "cost",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "cqlsh_url",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "creation_time",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "data_endpoint_url",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "grafana_url",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "graphql_url",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "id",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "last_usage_time",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "metrics",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "observed_status",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "org_id",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "owner_id",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "status",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "storage",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "termination_time",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_info",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.info.DatabaseInfo"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "info",
"type": "DatabaseInfo",
"description": "a DatabaseInfo instance for the underlying database.\nThe DatabaseInfo is a subset of the information described by\nAdminDatabaseInfo - in terms of the DevOps API response,\nit corresponds to just its \"info\" subdictionary."
},
{
"name": "available_actions",
"type": "list[str] | None",
"description": "the \"availableActions\" value in the full API response."
},
{
"name": "cost",
"type": "dict[str, Any]",
"description": "the \"cost\" value in the full API response."
},
{
"name": "cqlsh_url",
"type": "str",
"description": "the \"cqlshUrl\" value in the full API response."
},
{
"name": "creation_time",
"type": "str",
"description": "the \"creationTime\" value in the full API response."
},
{
"name": "data_endpoint_url",
"type": "str",
"description": "the \"dataEndpointUrl\" value in the full API response."
},
{
"name": "grafana_url",
"type": "str",
"description": "the \"grafanaUrl\" value in the full API response."
},
{
"name": "graphql_url",
"type": "str",
"description": "the \"graphqlUrl\" value in the full API response."
},
{
"name": "id",
"type": "str",
"description": "the \"id\" value in the full API response."
},
{
"name": "last_usage_time",
"type": "str",
"description": "the \"lastUsageTime\" value in the full API response."
},
{
"name": "metrics",
"type": "dict[str, Any]",
"description": "the \"metrics\" value in the full API response."
},
{
"name": "observed_status",
"type": "str",
"description": "the \"observedStatus\" value in the full API response."
},
{
"name": "org_id",
"type": "str",
"description": "the \"orgId\" value in the full API response."
},
{
"name": "owner_id",
"type": "str",
"description": "the \"ownerId\" value in the full API response."
},
{
"name": "status",
"type": "str",
"description": "the \"status\" value in the full API response."
},
{
"name": "storage",
"type": "dict[str, Any]",
"description": "the \"storage\" value in the full API response."
},
{
"name": "termination_time",
"type": "str",
"description": "the \"terminationTime\" value in the full API response."
},
{
"name": "raw_info",
"type": "dict[str, Any] | None",
"description": "the full raw response from the DevOps API."
}
]
}
|
astrapy.info.AdminDatabaseInfo.info
|
{
"kind": "attribute",
"name": "info",
"path": "astrapy.info.AdminDatabaseInfo.info",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.info.DatabaseInfo"
],
"value": "info: DatabaseInfo",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.available_actions
|
{
"kind": "attribute",
"name": "available_actions",
"path": "astrapy.info.AdminDatabaseInfo.available_actions",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "available_actions: list[str] | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.cost
|
{
"kind": "attribute",
"name": "cost",
"path": "astrapy.info.AdminDatabaseInfo.cost",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "cost: dict[str, Any]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.cqlsh_url
|
{
"kind": "attribute",
"name": "cqlsh_url",
"path": "astrapy.info.AdminDatabaseInfo.cqlsh_url",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "cqlsh_url: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.creation_time
|
{
"kind": "attribute",
"name": "creation_time",
"path": "astrapy.info.AdminDatabaseInfo.creation_time",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "creation_time: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.data_endpoint_url
|
{
"kind": "attribute",
"name": "data_endpoint_url",
"path": "astrapy.info.AdminDatabaseInfo.data_endpoint_url",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "data_endpoint_url: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.grafana_url
|
{
"kind": "attribute",
"name": "grafana_url",
"path": "astrapy.info.AdminDatabaseInfo.grafana_url",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "grafana_url: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.graphql_url
|
{
"kind": "attribute",
"name": "graphql_url",
"path": "astrapy.info.AdminDatabaseInfo.graphql_url",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "graphql_url: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.id
|
{
"kind": "attribute",
"name": "id",
"path": "astrapy.info.AdminDatabaseInfo.id",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "id: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.last_usage_time
|
{
"kind": "attribute",
"name": "last_usage_time",
"path": "astrapy.info.AdminDatabaseInfo.last_usage_time",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "last_usage_time: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.metrics
|
{
"kind": "attribute",
"name": "metrics",
"path": "astrapy.info.AdminDatabaseInfo.metrics",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "metrics: dict[str, Any]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.observed_status
|
{
"kind": "attribute",
"name": "observed_status",
"path": "astrapy.info.AdminDatabaseInfo.observed_status",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "observed_status: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.org_id
|
{
"kind": "attribute",
"name": "org_id",
"path": "astrapy.info.AdminDatabaseInfo.org_id",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "org_id: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.owner_id
|
{
"kind": "attribute",
"name": "owner_id",
"path": "astrapy.info.AdminDatabaseInfo.owner_id",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "owner_id: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.status
|
{
"kind": "attribute",
"name": "status",
"path": "astrapy.info.AdminDatabaseInfo.status",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "status: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.storage
|
{
"kind": "attribute",
"name": "storage",
"path": "astrapy.info.AdminDatabaseInfo.storage",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "storage: dict[str, Any]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.info.AdminDatabaseInfo.termination_time
|
{
"kind": "attribute",
"name": "termination_time",
"path": "astrapy.info.AdminDatabaseInfo.termination_time",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "termination_time: str",
"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.