id
stringlengths 7
77
| text
stringlengths 0
3.4k
| metadata
dict |
|---|---|---|
astrapy.collection.AsyncCollection.update_many
|
Apply an update operations to all documents matching a condition,
optionally inserting one documents in absence of matches.
|
{
"kind": "function",
"name": "update_many",
"path": "astrapy.collection.AsyncCollection.update_many",
"parameters": [
{
"name": "filter",
"type": "FilterType",
"description": "a predicate expressed as a dictionary according to the\nData API filter syntax. Examples are:\n {}\n {\"name\": \"John\"}\n {\"price\": {\"$lt\": 100}}\n {\"$and\": [{\"name\": \"John\"}, {\"price\": {\"$lt\": 100}}]}\nSee the Data API documentation for the full set of operators.",
"default": null,
"value": null
},
{
"name": "update",
"type": "dict[str, Any]",
"description": "the update prescription to apply to the documents, expressed\nas a dictionary as per Data API syntax. Examples are:\n {\"$set\": {\"field\": \"value}}\n {\"$inc\": {\"counter\": 10}}\n {\"$unset\": {\"field\": \"\"}}\nSee the Data API documentation for the full syntax.",
"default": null,
"value": null
},
{
"name": "upsert",
"type": "bool",
"description": "this parameter controls the behavior in absence of matches.\nIf True, a single new document (resulting from applying `update`\nto an empty document) is inserted if no matches are found on\nthe collection. If False, the operation silently does nothing\nin case of no matches.",
"default": "False",
"value": "False"
},
{
"name": "max_time_ms",
"type": "int | None",
"description": "a timeout, in milliseconds, for the operation.\nIf not passed, the collection-level setting is used instead:\nif a large number of document updates is anticipated, it is suggested\nto specify a larger timeout than in most other operations as the\nupdate will span several HTTP calls to the API in sequence.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "UpdateResult",
"description": "an UpdateResult object summarizing the outcome of the update operation."
}
],
"gathered_types": [
"astrapy.constants.FilterType",
"astrapy.results.UpdateResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": ">>> async def do_update_many(acol: AsyncCollection) -> None:\n... await acol.insert_many([{\"c\": \"red\"}, {\"c\": \"green\"}, {\"c\": \"blue\"}])\n... result0 = await acol.update_many(\n... {\"c\": {\"$ne\": \"green\"}},\n... {\"$set\": {\"nongreen\": True}},\n... )\n... print(\"result0.update_info\", result0.update_info)\n... result1 = await acol.update_many(\n... {\"c\": \"orange\"},\n... {\"$set\": {\"is_also_fruit\": True}},\n... )\n... print(\"result1.update_info\", result1.update_info)\n... result2 = await acol.update_many(\n... {\"c\": \"orange\"},\n... {\"$set\": {\"is_also_fruit\": True}},\n... upsert=True,\n... )\n... print(\"result2.update_info\", result2.update_info)\n...\n>>> asyncio.run(do_update_many(my_async_coll))\nresult0.update_info {'n': 2, 'updatedExisting': True, 'ok': 1.0, 'nModified': 2}\nresult1.update_info {'n': 0, 'updatedExisting': False, 'ok': 1.0, 'nModified': 0}\nresult2.update_info {'n': 1, 'updatedExisting': False, 'ok': 1.0, 'nModified': 0, 'upserted': '79ffd5a3-ab99-4dff-a2a5-4aaa0e59e854'}",
"references": null,
"note": "Similarly to the case of `find` (see its docstring for more details),\nrunning this command while, at the same time, another process is\ninserting new documents which match the filter of the `update_many`\ncan result in an unpredictable fraction of these documents being updated.\nIn other words, it cannot be easily predicted whether a given\nnewly-inserted document will be picked up by the update_many command or not.",
"implemented_by": null,
"attributes": null
}
|
astrapy.collection.AsyncCollection.find_one_and_delete
|
Find a document in the collection and delete it. The deleted document,
however, is the return value of the method.
|
{
"kind": "function",
"name": "find_one_and_delete",
"path": "astrapy.collection.AsyncCollection.find_one_and_delete",
"parameters": [
{
"name": "filter",
"type": "FilterType",
"description": "a predicate expressed as a dictionary according to the\nData API filter syntax. Examples are:\n {}\n {\"name\": \"John\"}\n {\"price\": {\"$lt\": 100}}\n {\"$and\": [{\"name\": \"John\"}, {\"price\": {\"$lt\": 100}}]}\nSee the Data API documentation for the full set of operators.",
"default": null,
"value": null
},
{
"name": "projection",
"type": "ProjectionType | None",
"description": "it controls which parts of the document are returned.\nIt can be an allow-list: `{\"f1\": True, \"f2\": True}`,\nor a deny-list: `{\"fx\": False, \"fy\": False}`, but not a mixture\n(except for the `_id` and other special fields, which can be\nassociated to both True or False independently of the rest\nof the specification).\nThe special star-projections `{\"*\": True}` and `{\"*\": False}`\nhave the effect of returning the whole document and `{}` respectively.\nFor lists in documents, slice directives can be passed to select\nportions of the list: for instance, `{\"array\": {\"$slice\": 2}}`,\n`{\"array\": {\"$slice\": -2}}`, `{\"array\": {\"$slice\": [4, 2]}}` or\n`{\"array\": {\"$slice\": [-4, 2]}}`.\nAn iterable over strings will be treated implicitly as an allow-list.\nThe default projection (used if this parameter is not passed) does not\nnecessarily include \"special\" fields such as `$vector` or `$vectorize`.\nSee the Data API documentation for more on projections.",
"default": "None",
"value": "None"
},
{
"name": "vector",
"type": "VectorType | None",
"description": "a suitable vector, i.e. a list of float numbers of the appropriate\ndimensionality, to use vector search (i.e. ANN,\nor \"approximate nearest-neighbours\" search), as the sorting criterion.\nIn this way, the matched document (if any) will be the one\nthat is most similar to the provided vector.\n*DEPRECATED* (removal in 2.0). Use a `$vector` key in the\nsort clause dict instead.",
"default": "None",
"value": "None"
},
{
"name": "vectorize",
"type": "str | None",
"description": "a string to be made into a vector to perform vector search.\nUsing vectorize assumes a suitable service is configured for the collection.\n*DEPRECATED* (removal in 2.0). Use a `$vectorize` key in the\nsort clause dict instead.",
"default": "None",
"value": "None"
},
{
"name": "sort",
"type": "SortType | None",
"description": "with this dictionary parameter one can control the sorting\norder of the documents matching the filter, effectively\ndetermining what document will come first and hence be the\nreplaced one. See the `find` method for more on sorting.\nVector-based ANN sorting is achieved by providing a \"$vector\"\nor a \"$vectorize\" key in `sort`.",
"default": "None",
"value": "None"
},
{
"name": "max_time_ms",
"type": "int | None",
"description": "a timeout, in milliseconds, for the underlying HTTP request.\nIf not passed, the collection-level setting is used instead.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "DocumentType | None",
"description": "Either the document (or a projection thereof, as requested), or None"
},
{
"name": null,
"type": "DocumentType | None",
"description": "if no matches were found in the first place."
}
],
"gathered_types": [
"astrapy.constants.FilterType",
"astrapy.constants.SortType",
"astrapy.constants.DocumentType",
"astrapy.constants.VectorType",
"astrapy.constants.ProjectionType"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": ">>> async def do_find_one_and_delete(acol: AsyncCollection) -> None:\n... await acol.insert_many(\n... [\n... {\"species\": \"swan\", \"class\": \"Aves\"},\n... {\"species\": \"frog\", \"class\": \"Amphibia\"},\n... ],\n... )\n... delete_result0 = await acol.find_one_and_delete(\n... {\"species\": {\"$ne\": \"frog\"}},\n... projection=[\"species\"],\n... )\n... print(\"delete_result0\", delete_result0)\n... delete_result1 = await acol.find_one_and_delete(\n... {\"species\": {\"$ne\": \"frog\"}},\n... )\n... print(\"delete_result1\", delete_result1)\n...\n>>> asyncio.run(do_find_one_and_delete(my_async_coll))\ndelete_result0 {'_id': 'f335cd0f-...', 'species': 'swan'}\ndelete_result1 None",
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.collection.AsyncCollection.delete_one
|
Delete one document matching a provided filter.
This method never deletes more than a single document, regardless
of the number of matches to the provided filters.
|
{
"kind": "function",
"name": "delete_one",
"path": "astrapy.collection.AsyncCollection.delete_one",
"parameters": [
{
"name": "filter",
"type": "FilterType",
"description": "a predicate expressed as a dictionary according to the\nData API filter syntax. Examples are:\n {}\n {\"name\": \"John\"}\n {\"price\": {\"$lt\": 100}}\n {\"$and\": [{\"name\": \"John\"}, {\"price\": {\"$lt\": 100}}]}\nSee the Data API documentation for the full set of operators.",
"default": null,
"value": null
},
{
"name": "vector",
"type": "VectorType | None",
"description": "a suitable vector, i.e. a list of float numbers of the appropriate\ndimensionality, to use vector search (i.e. ANN,\nor \"approximate nearest-neighbours\" search), as the sorting criterion.\nIn this way, the matched document (if any) will be the one\nthat is most similar to the provided vector.\n*DEPRECATED* (removal in 2.0). Use a `$vector` key in the\nsort clause dict instead.",
"default": "None",
"value": "None"
},
{
"name": "vectorize",
"type": "str | None",
"description": "a string to be made into a vector to perform vector search.\nUsing vectorize assumes a suitable service is configured for the collection.\n*DEPRECATED* (removal in 2.0). Use a `$vectorize` key in the\nsort clause dict instead.",
"default": "None",
"value": "None"
},
{
"name": "sort",
"type": "SortType | None",
"description": "with this dictionary parameter one can control the sorting\norder of the documents matching the filter, effectively\ndetermining what document will come first and hence be the\nreplaced one. See the `find` method for more on sorting.\nVector-based ANN sorting is achieved by providing a \"$vector\"\nor a \"$vectorize\" key in `sort`.",
"default": "None",
"value": "None"
},
{
"name": "max_time_ms",
"type": "int | None",
"description": "a timeout, in milliseconds, for the underlying HTTP request.\nIf not passed, the collection-level setting is used instead.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "DeleteResult",
"description": "a DeleteResult object summarizing the outcome of the delete operation."
}
],
"gathered_types": [
"astrapy.constants.FilterType",
"astrapy.constants.SortType",
"astrapy.constants.VectorType",
"astrapy.results.DeleteResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": ">>> my_coll.insert_many([{\"seq\": 1}, {\"seq\": 0}, {\"seq\": 2}])\nInsertManyResult(...)\n>>> my_coll.delete_one({\"seq\": 1})\nDeleteResult(raw_results=..., deleted_count=1)\n>>> my_coll.distinct(\"seq\")\n[0, 2]\n>>> my_coll.delete_one(\n... {\"seq\": {\"$exists\": True}},\n... sort={\"seq\": astrapy.constants.SortDocuments.DESCENDING},\n... )\nDeleteResult(raw_results=..., deleted_count=1)\n>>> my_coll.distinct(\"seq\")\n[0]\n>>> my_coll.delete_one({\"seq\": 2})\nDeleteResult(raw_results=..., deleted_count=0)",
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.collection.AsyncCollection.delete_many
|
Delete all documents matching a provided filter.
|
{
"kind": "function",
"name": "delete_many",
"path": "astrapy.collection.AsyncCollection.delete_many",
"parameters": [
{
"name": "filter",
"type": "FilterType",
"description": "a predicate expressed as a dictionary according to the\nData API filter syntax. Examples are:\n {}\n {\"name\": \"John\"}\n {\"price\": {\"$lt\": 100}}\n {\"$and\": [{\"name\": \"John\"}, {\"price\": {\"$lt\": 100}}]}\nSee the Data API documentation for the full set of operators.\nPassing an empty filter, `{}`, completely erases all contents\nof the collection.",
"default": null,
"value": null
},
{
"name": "max_time_ms",
"type": "int | None",
"description": "a timeout, in milliseconds, for the operation.\nIf not passed, the collection-level setting is used instead:\nkeep in mind that this method entails successive HTTP requests\nto the API, depending on how many documents are to be deleted.\nFor this reason, in most cases it is suggested to relax the\ntimeout compared to other method calls.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "DeleteResult",
"description": "a DeleteResult object summarizing the outcome of the delete operation."
}
],
"gathered_types": [
"astrapy.constants.FilterType",
"astrapy.results.DeleteResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": ">>> async def do_delete_many(acol: AsyncCollection) -> None:\n... await acol.insert_many([{\"seq\": 1}, {\"seq\": 0}, {\"seq\": 2}])\n... delete_result0 = await acol.delete_many({\"seq\": {\"$lte\": 1}})\n... print(\"delete_result0.deleted_count\", delete_result0.deleted_count)\n... distinct1 = await acol.distinct(\"seq\")\n... print(\"distinct1\", distinct1)\n... delete_result2 = await acol.delete_many({\"seq\": {\"$lte\": 1}})\n... print(\"delete_result2.deleted_count\", delete_result2.deleted_count)\n...\n>>> asyncio.run(do_delete_many(my_async_coll))\ndelete_result0.deleted_count 2\ndistinct1 [2]\ndelete_result2.deleted_count 0",
"references": null,
"note": "This operation is in general not atomic. Depending on the amount\nof matching documents, it can keep running (in a blocking way)\nfor a macroscopic time. In that case, new documents that are\nmeanwhile inserted (e.g. from another process/application) will be\ndeleted during the execution of this method call until the\ncollection is devoid of matches.\nAn exception is the `filter={}` case, whereby the operation is atomic.",
"implemented_by": null,
"attributes": null
}
|
astrapy.collection.AsyncCollection.delete_all
|
Delete all documents in a collection.
|
{
"kind": "function",
"name": "delete_all",
"path": "astrapy.collection.AsyncCollection.delete_all",
"parameters": [
{
"name": "max_time_ms",
"type": "int | None",
"description": "a timeout, in milliseconds, for the underlying HTTP request.\nIf not passed, the collection-level setting is used instead.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"description": "a dictionary of the form {\"ok\": 1} to signal successful deletion."
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": ">>> async def do_delete_all(acol: AsyncCollection) -> None:\n... distinct0 = await acol.distinct(\"seq\")\n... print(\"distinct0\", distinct0)\n... count1 = await acol.count_documents({}, upper_bound=100)\n... print(\"count1\", count1)\n... delete_result2 = await acol.delete_all()\n... print(\"delete_result2\", delete_result2)\n... count3 = await acol.count_documents({}, upper_bound=100)\n... print(\"count3\", count3)\n...\n>>> asyncio.run(do_delete_all(my_async_coll))\ndistinct0 [4, 2, 3, 0, 1]\ncount1 5\ndelete_result2 {'ok': 1}\ncount3 0",
"references": null,
"note": "Use with caution.",
"implemented_by": null,
"attributes": null
}
|
astrapy.collection.AsyncCollection.bulk_write
|
Execute an arbitrary amount of operations such as inserts, updates, deletes
either sequentially or concurrently.
This method does not execute atomically, i.e. individual operations are
each performed in the same way as the corresponding collection method,
and each one is a different and unrelated database mutation.
|
{
"kind": "function",
"name": "bulk_write",
"path": "astrapy.collection.AsyncCollection.bulk_write",
"parameters": [
{
"name": "requests",
"type": "Iterable[AsyncBaseOperation]",
"description": "an iterable over concrete subclasses of `BaseOperation`,\nsuch as `AsyncInsertMany` or `AsyncReplaceOne`. Each such object\nrepresents an operation ready to be executed on a collection,\nand is instantiated by passing the same parameters as one\nwould the corresponding collection method.",
"default": null,
"value": null
},
{
"name": "ordered",
"type": "bool",
"description": "whether to launch the `requests` one after the other or\nin arbitrary order, possibly in a concurrent fashion. For\nperformance reasons, False (default) should be preferred\nwhen compatible with the needs of the application flow.",
"default": "False",
"value": "False"
},
{
"name": "concurrency",
"type": "int | None",
"description": "maximum number of concurrent operations executing at\na given time. It cannot be more than one for ordered bulk writes.",
"default": "None",
"value": "None"
},
{
"name": "max_time_ms",
"type": "int | None",
"description": "a timeout, in milliseconds, for the whole bulk write.\nRemember that, if the method call times out, then there's no\nguarantee about what portion of the bulk write has been received\nand successfully executed by the Data API.\nIf not passed, the collection-level setting is used instead:\nin most cases, however, one should pass a relaxed timeout\nif longer sequences of operations are to be executed in bulk.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": "A single BulkWriteResult summarizing the whole list of requested"
},
{
"name": null,
"type": "BulkWriteResult",
"description": "operations. The keys in the map attributes of BulkWriteResult"
},
{
"name": null,
"type": "BulkWriteResult",
"description": "(when present) are the integer indices of the corresponding operation"
},
{
"name": null,
"type": "BulkWriteResult",
"description": "in the `requests` iterable."
}
],
"gathered_types": [
"astrapy.operations.AsyncBaseOperation",
"astrapy.results.BulkWriteResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": ">>> from astrapy.operations import AsyncInsertMany, AsyncReplaceOne, AsyncOperation\n>>> from astrapy.results import BulkWriteResult\n>>>\n>>> async def do_bulk_write(\n... acol: AsyncCollection,\n... async_operations: List[AsyncOperation],\n... ) -> BulkWriteResult:\n... bw_result = await acol.bulk_write(async_operations)\n... count0 = await acol.count_documents({}, upper_bound=100)\n... print(\"count0\", count0)\n... distinct0 = await acol.distinct(\"replaced\")\n... print(\"distinct0\", distinct0)\n... return bw_result\n...\n>>> op1 = AsyncInsertMany([{\"a\": 1}, {\"a\": 2}])\n>>> op2 = AsyncReplaceOne(\n... {\"z\": 9},\n... replacement={\"z\": 9, \"replaced\": True},\n... upsert=True,\n... )\n>>> result = asyncio.run(do_bulk_write(my_async_coll, [op1, op2]))\ncount0 3\ndistinct0 [True]\n>>> print(\"result\", result)\nresult BulkWriteResult(bulk_api_results={0: ..., 1: ...}, deleted_count=0, inserted_count=3, matched_count=0, modified_count=0, upserted_count=1, upserted_ids={1: 'ccd0a800-...'})",
"references": [
"astrapy.results.BulkWriteResult",
"astrapy.operations.AsyncReplaceOne",
"astrapy.operations.AsyncInsertMany",
"astrapy.operations.AsyncOperation"
],
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.collection.AsyncCollection.drop
|
Drop the collection, i.e. delete it from the database along with
all the documents it contains.
|
{
"kind": "function",
"name": "drop",
"path": "astrapy.collection.AsyncCollection.drop",
"parameters": [
{
"name": "max_time_ms",
"type": "int | None",
"description": "a timeout, in milliseconds, for the underlying HTTP request.\nIf not passed, the collection-level setting is used instead.\nRemember there is not guarantee that a request that has\ntimed out us not in fact honored.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"description": "a dictionary of the form {\"ok\": 1} to signal successful deletion."
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": ">>> async def drop_and_check(acol: AsyncCollection) -> None:\n... doc0 = await acol.find_one({})\n... print(\"doc0\", doc0)\n... drop_result = await acol.drop()\n... print(\"drop_result\", drop_result)\n... doc1 = await acol.find_one({})\n...\n>>> asyncio.run(drop_and_check(my_async_coll))\ndoc0 {'_id': '...', 'z': -10}\ndrop_result {'ok': 1}\nTraceback (most recent call last):\n ... ...\nastrapy.exceptions.DataAPIResponseException: Collection does not exist, collection name: my_collection",
"references": null,
"note": "Once the method succeeds, methods on this object can still be invoked:\nhowever, this hardly makes sense as the underlying actual collection\nis no more.\nIt is responsibility of the developer to design a correct flow\nwhich avoids using a deceased collection any further.",
"implemented_by": null,
"attributes": null
}
|
astrapy.collection.AsyncCollection.command
|
Send a POST request to the Data API for this collection with
an arbitrary, caller-provided payload.
|
{
"kind": "function",
"name": "command",
"path": "astrapy.collection.AsyncCollection.command",
"parameters": [
{
"name": "body",
"type": "dict[str, Any]",
"description": "a JSON-serializable dictionary, the payload of the request.",
"default": null,
"value": null
},
{
"name": "raise_api_errors",
"type": "bool",
"description": "if True, responses with a nonempty 'errors' field\nresult in an astrapy exception being raised.",
"default": "True",
"value": "True"
},
{
"name": "max_time_ms",
"type": "int | None",
"description": "a timeout, in milliseconds, for the underlying HTTP request.\nIf not passed, the collection-level setting is used instead.",
"default": "None",
"value": "None"
}
],
"returns": [
{
"name": null,
"type": "dict[str, Any]",
"description": "a dictionary with the response of the HTTP request."
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": ">>> asyncio.await(my_async_coll.command({\"countDocuments\": {}}))\n{'status': {'count': 123}}",
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.exceptions
|
{
"kind": "module",
"name": "exceptions",
"path": "astrapy.exceptions",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": null,
"Any": "typing.Any",
"cast": null,
"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": null,
"http_methods": null,
"to_httpx_timeout": null,
"Dict": null,
"List": null,
"Protocol": null,
"Union": null,
"datetime": null,
"json": null,
"time": "time",
"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": "typing.TYPE_CHECKING",
"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": "astrapy.results.BulkWriteResult",
"DeleteResult": "astrapy.results.DeleteResult",
"InsertManyResult": "astrapy.results.InsertManyResult",
"InsertOneResult": null,
"UpdateResult": "astrapy.results.UpdateResult",
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": "dataclasses.dataclass",
"TimeoutInfo": "astrapy.request_tools.TimeoutInfo",
"OperationResult": "astrapy.results.OperationResult",
"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.exceptions.DevOpsAPIException
|
An exception specific to issuing requests to the DevOps API.
|
{
"kind": "class",
"name": "DevOpsAPIException",
"path": "astrapy.exceptions.DevOpsAPIException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": "''",
"value": null
}
],
"returns": null,
"gathered_types": [
"ValueError"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"ValueError"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": [
"astrapy.exceptions.DevOpsAPIFaultyResponseException",
"astrapy.exceptions.DevOpsAPIResponseException",
"astrapy.exceptions.DevOpsAPITimeoutException",
"astrapy.exceptions.DevOpsAPIHttpException"
],
"attributes": null
}
|
astrapy.exceptions.DevOpsAPIHttpException
|
A request to the DevOps API resulted in an HTTP 4xx or 5xx response.
Though the DevOps API seldom enriches such errors with a response text,
this class acts as the DevOps counterpart to DataAPIHttpException
to facilitate a symmetryc handling of errors at application lebel.
|
{
"kind": "class",
"name": "DevOpsAPIHttpException",
"path": "astrapy.exceptions.DevOpsAPIHttpException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "httpx_error",
"type": "httpx.HTTPStatusError",
"description": null,
"default": null,
"value": null
},
{
"name": "error_descriptors",
"type": "list[DevOpsAPIErrorDescriptor]",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"DevOpsAPIErrorDescriptor",
"HTTPStatusError",
"astrapy.exceptions.DevOpsAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.exceptions.DevOpsAPIException",
"httpx.HTTPStatusError"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str | None",
"description": "a text message about the exception."
},
{
"name": "error_descriptors",
"type": "list[DevOpsAPIErrorDescriptor]",
"description": "a list of all DevOpsAPIErrorDescriptor objects\nfound in the response."
}
]
}
|
astrapy.exceptions.DevOpsAPIHttpException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DevOpsAPIHttpException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str | None = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIHttpException.error_descriptors
|
{
"kind": "attribute",
"name": "error_descriptors",
"path": "astrapy.exceptions.DevOpsAPIHttpException.error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DevOpsAPIErrorDescriptor"
],
"value": "error_descriptors: list[DevOpsAPIErrorDescriptor] = error_descriptors",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIHttpException.httpx_error
|
{
"kind": "attribute",
"name": "httpx_error",
"path": "astrapy.exceptions.DevOpsAPIHttpException.httpx_error",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "httpx_error = httpx_error",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIHttpException.from_httpx_error
|
Parse a httpx status error into this exception.
|
{
"kind": "function",
"name": "from_httpx_error",
"path": "astrapy.exceptions.DevOpsAPIHttpException.from_httpx_error",
"parameters": [
{
"name": "cls",
"type": null,
"description": null,
"default": null,
"value": null
},
{
"name": "httpx_error",
"type": "httpx.HTTPStatusError",
"description": null,
"default": null,
"value": null
},
{
"name": "kwargs",
"type": "Any",
"description": null,
"default": "{}",
"value": null
}
],
"returns": [
{
"name": null,
"type": "DevOpsAPIHttpException",
"description": null
}
],
"gathered_types": [
"astrapy.exceptions.DevOpsAPIHttpException",
"HTTPStatusError"
],
"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.DevOpsAPITimeoutException
|
A DevOps API operation timed out.
|
{
"kind": "class",
"name": "DevOpsAPITimeoutException",
"path": "astrapy.exceptions.DevOpsAPITimeoutException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "timeout_type",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "endpoint",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_payload",
"type": "str | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.exceptions.DevOpsAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.exceptions.DevOpsAPIException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str",
"description": "a textual description of the error"
},
{
"name": "timeout_type",
"type": "str",
"description": "this denotes the phase of the HTTP request when the event\noccurred (\"connect\", \"read\", \"write\", \"pool\") or \"generic\" if there is\nnot a specific request associated to the exception."
},
{
"name": "endpoint",
"type": "str | None",
"description": "if the timeout is tied to a specific request, this is the\nURL that the request was targeting."
},
{
"name": "raw_payload",
"type": "str | None",
"description": "if the timeout is tied to a specific request, this is the\nassociated payload (as a string)."
}
]
}
|
astrapy.exceptions.DevOpsAPITimeoutException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DevOpsAPITimeoutException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPITimeoutException.timeout_type
|
{
"kind": "attribute",
"name": "timeout_type",
"path": "astrapy.exceptions.DevOpsAPITimeoutException.timeout_type",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "timeout_type: str = timeout_type",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPITimeoutException.endpoint
|
{
"kind": "attribute",
"name": "endpoint",
"path": "astrapy.exceptions.DevOpsAPITimeoutException.endpoint",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "endpoint: str | None = endpoint",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPITimeoutException.raw_payload
|
{
"kind": "attribute",
"name": "raw_payload",
"path": "astrapy.exceptions.DevOpsAPITimeoutException.raw_payload",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_payload: str | None = raw_payload",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIErrorDescriptor
|
An object representing a single error returned from the DevOps API,
typically with an error code and a text message.
A single response from the Devops API may return zero, one or more of these.
|
{
"kind": "class",
"name": "DevOpsAPIErrorDescriptor",
"path": "astrapy.exceptions.DevOpsAPIErrorDescriptor",
"parameters": [
{
"name": "error_dict",
"type": "dict[str, Any]",
"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": null,
"implemented_by": null,
"attributes": [
{
"name": "id",
"type": "int | None",
"description": "a numeric code as found in the API \"ID\" item."
},
{
"name": "message",
"type": "str | None",
"description": "the text found in the API \"error\" item."
},
{
"name": "attributes",
"type": "dict[str, Any]",
"description": "a dict with any further key-value pairs returned by the API."
}
]
}
|
astrapy.exceptions.DevOpsAPIErrorDescriptor.id
|
{
"kind": "attribute",
"name": "id",
"path": "astrapy.exceptions.DevOpsAPIErrorDescriptor.id",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "id: int | None = error_dict.get('ID')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIErrorDescriptor.message
|
{
"kind": "attribute",
"name": "message",
"path": "astrapy.exceptions.DevOpsAPIErrorDescriptor.message",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "message: str | None = error_dict.get('message')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIErrorDescriptor.attributes
|
{
"kind": "attribute",
"name": "attributes",
"path": "astrapy.exceptions.DevOpsAPIErrorDescriptor.attributes",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "attributes: dict[str, Any] = {k: vfor (k, v) in error_dict.items() if k not in {'ID', 'message'}}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIFaultyResponseException
|
The DevOps API response is malformed in that it does not have
expected field(s), or they are of the wrong type.
|
{
"kind": "class",
"name": "DevOpsAPIFaultyResponseException",
"path": "astrapy.exceptions.DevOpsAPIFaultyResponseException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_response",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.exceptions.DevOpsAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.exceptions.DevOpsAPIException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str",
"description": "a text message about the exception."
},
{
"name": "raw_response",
"type": "dict[str, Any] | None",
"description": "the response returned by the API in the form of a dict."
}
]
}
|
astrapy.exceptions.DevOpsAPIFaultyResponseException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DevOpsAPIFaultyResponseException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIFaultyResponseException.raw_response
|
{
"kind": "attribute",
"name": "raw_response",
"path": "astrapy.exceptions.DevOpsAPIFaultyResponseException.raw_response",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_response: dict[str, Any] | None = raw_response",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIResponseException
|
A request to the DevOps API returned with a non-success return code
and one of more errors in the HTTP response.
|
{
"kind": "class",
"name": "DevOpsAPIResponseException",
"path": "astrapy.exceptions.DevOpsAPIResponseException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "command",
"type": "dict[str, Any] | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "error_descriptors",
"type": "list[DevOpsAPIErrorDescriptor]",
"description": null,
"default": "[]",
"value": null
}
],
"returns": null,
"gathered_types": [
"DevOpsAPIErrorDescriptor",
"astrapy.exceptions.DevOpsAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.exceptions.DevOpsAPIException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str | None",
"description": "a text message about the exception."
},
{
"name": "command",
"type": "dict[str, Any] | None",
"description": "the raw payload that was sent to the DevOps API."
},
{
"name": "error_descriptors",
"type": "list[DevOpsAPIErrorDescriptor]",
"description": "a list of all DevOpsAPIErrorDescriptor objects\nreturned by the API in the response."
}
]
}
|
astrapy.exceptions.DevOpsAPIResponseException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DevOpsAPIResponseException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str | None = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIResponseException.command
|
{
"kind": "attribute",
"name": "command",
"path": "astrapy.exceptions.DevOpsAPIResponseException.command",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "command: dict[str, Any] | None = command",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIResponseException.error_descriptors
|
{
"kind": "attribute",
"name": "error_descriptors",
"path": "astrapy.exceptions.DevOpsAPIResponseException.error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DevOpsAPIErrorDescriptor"
],
"value": "error_descriptors: list[DevOpsAPIErrorDescriptor] = error_descriptors",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DevOpsAPIResponseException.from_response
|
Parse a raw response from the API into this exception.
|
{
"kind": "function",
"name": "from_response",
"path": "astrapy.exceptions.DevOpsAPIResponseException.from_response",
"parameters": [
{
"name": "command",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_response",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "DevOpsAPIResponseException",
"description": null
}
],
"gathered_types": [
"astrapy.exceptions.DevOpsAPIResponseException"
],
"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.DataAPIErrorDescriptor
|
An object representing a single error returned from the Data API,
typically with an error code and a text message.
An API request would return with an HTTP 200 success error code,
but contain a nonzero amount of these.
A single response from the Data API may return zero, one or more of these.
Moreover, some operations, such as an insert_many, may partally succeed
yet return these errors about the rest of the operation (such as,
some of the input documents could not be inserted).
|
{
"kind": "class",
"name": "DataAPIErrorDescriptor",
"path": "astrapy.exceptions.DataAPIErrorDescriptor",
"parameters": [
{
"name": "error_dict",
"type": "dict[str, str]",
"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": null,
"implemented_by": null,
"attributes": [
{
"name": "error_code",
"type": "str | None",
"description": "a string code as found in the API \"error\" item."
},
{
"name": "message",
"type": "str | None",
"description": "the text found in the API \"error\" item."
},
{
"name": "attributes",
"type": "dict[str, Any]",
"description": "a dict with any further key-value pairs returned by the API."
}
]
}
|
astrapy.exceptions.DataAPIErrorDescriptor.title
|
{
"kind": "attribute",
"name": "title",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.title",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "title: str | None = error_dict.get('title')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIErrorDescriptor.error_code
|
{
"kind": "attribute",
"name": "error_code",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.error_code",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "error_code: str | None = error_dict.get('errorCode')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIErrorDescriptor.message
|
{
"kind": "attribute",
"name": "message",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.message",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "message: str | None = error_dict.get('message')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIErrorDescriptor.family
|
{
"kind": "attribute",
"name": "family",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.family",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "family: str | None = error_dict.get('family')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIErrorDescriptor.scope
|
{
"kind": "attribute",
"name": "scope",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.scope",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "scope: str | None = error_dict.get('scope')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIErrorDescriptor.id
|
{
"kind": "attribute",
"name": "id",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.id",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "id: str | None = error_dict.get('id')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIErrorDescriptor.attributes
|
{
"kind": "attribute",
"name": "attributes",
"path": "astrapy.exceptions.DataAPIErrorDescriptor.attributes",
"parameters": null,
"returns": null,
"gathered_types": [
"_known_dict_fields"
],
"value": "attributes: dict[str, Any] = {k: vfor (k, v) in error_dict.items() if k not in self._known_dict_fields}",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIDetailedErrorDescriptor
|
An object representing an errorful response from the Data API.
Errors specific to the Data API (as opposed to e.g. network failures)
would result in an HTTP 200 success response code but coming with
one or more DataAPIErrorDescriptor objects.
This object corresponds to one response, and as such its attributes
are a single request payload, a single response, but a list of
DataAPIErrorDescriptor instances.
|
{
"kind": "class",
"name": "DataAPIDetailedErrorDescriptor",
"path": "astrapy.exceptions.DataAPIDetailedErrorDescriptor",
"parameters": [
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": null,
"default": null,
"value": null
},
{
"name": "command",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_response",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIErrorDescriptor"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": "a list of DataAPIErrorDescriptor objects."
},
{
"name": "command",
"type": "dict[str, Any] | None",
"description": "the raw payload of the API request."
},
{
"name": "raw_response",
"type": "dict[str, Any]",
"description": "the full API response in the form of a dict."
}
]
}
|
astrapy.exceptions.DataAPIDetailedErrorDescriptor.error_descriptors
|
{
"kind": "attribute",
"name": "error_descriptors",
"path": "astrapy.exceptions.DataAPIDetailedErrorDescriptor.error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DataAPIErrorDescriptor"
],
"value": "error_descriptors: list[DataAPIErrorDescriptor]",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIDetailedErrorDescriptor.command
|
{
"kind": "attribute",
"name": "command",
"path": "astrapy.exceptions.DataAPIDetailedErrorDescriptor.command",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "command: 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.exceptions.DataAPIDetailedErrorDescriptor.raw_response
|
{
"kind": "attribute",
"name": "raw_response",
"path": "astrapy.exceptions.DataAPIDetailedErrorDescriptor.raw_response",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_response: 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.exceptions.DataAPIException
|
Any exception occurred while issuing requests to the Data API
and specific to it, such as:
- a collection is found not to exist when gettings its metadata,
- the API return a response with an error,
but not, for instance,
- a network error while sending an HTTP request to the API.
|
{
"kind": "class",
"name": "DataAPIException",
"path": "astrapy.exceptions.DataAPIException",
"parameters": null,
"returns": null,
"gathered_types": [
"ValueError"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"ValueError"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.exceptions.DataAPIHttpException
|
A request to the Data API resulted in an HTTP 4xx or 5xx response.
In most cases this comes with additional information: the purpose
of this class is to present such information in a structured way,
akin to what happens for the DataAPIResponseException, while
still raising (a subclass of) `httpx.HTTPStatusError`.
|
{
"kind": "class",
"name": "DataAPIHttpException",
"path": "astrapy.exceptions.DataAPIHttpException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "httpx_error",
"type": "httpx.HTTPStatusError",
"description": null,
"default": null,
"value": null
},
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"HTTPStatusError",
"DataAPIErrorDescriptor",
"DataAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"DataAPIException",
"httpx.HTTPStatusError"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str | None",
"description": "a text message about the exception."
},
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": "a list of all DataAPIErrorDescriptor objects\nfound in the response."
}
]
}
|
astrapy.exceptions.DataAPIHttpException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DataAPIHttpException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str | None = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIHttpException.error_descriptors
|
{
"kind": "attribute",
"name": "error_descriptors",
"path": "astrapy.exceptions.DataAPIHttpException.error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DataAPIErrorDescriptor"
],
"value": "error_descriptors: list[DataAPIErrorDescriptor] = error_descriptors",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIHttpException.httpx_error
|
{
"kind": "attribute",
"name": "httpx_error",
"path": "astrapy.exceptions.DataAPIHttpException.httpx_error",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "httpx_error = httpx_error",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIHttpException.from_httpx_error
|
Parse a httpx status error into this exception.
|
{
"kind": "function",
"name": "from_httpx_error",
"path": "astrapy.exceptions.DataAPIHttpException.from_httpx_error",
"parameters": [
{
"name": "cls",
"type": null,
"description": null,
"default": null,
"value": null
},
{
"name": "httpx_error",
"type": "httpx.HTTPStatusError",
"description": null,
"default": null,
"value": null
},
{
"name": "kwargs",
"type": "Any",
"description": null,
"default": "{}",
"value": null
}
],
"returns": [
{
"name": null,
"type": "DataAPIHttpException",
"description": null
}
],
"gathered_types": [
"HTTPStatusError",
"astrapy.exceptions.DataAPIHttpException"
],
"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.DataAPITimeoutException
|
A Data API operation timed out. This can be a request timeout occurring
during a specific HTTP request, or can happen over the course of a method
involving several requests in a row, such as a paginated find.
|
{
"kind": "class",
"name": "DataAPITimeoutException",
"path": "astrapy.exceptions.DataAPITimeoutException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "timeout_type",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "endpoint",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_payload",
"type": "str | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"DataAPIException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str",
"description": "a textual description of the error"
},
{
"name": "timeout_type",
"type": "str",
"description": "this denotes the phase of the HTTP request when the event\noccurred (\"connect\", \"read\", \"write\", \"pool\") or \"generic\" if there is\nnot a specific request associated to the exception."
},
{
"name": "endpoint",
"type": "str | None",
"description": "if the timeout is tied to a specific request, this is the\nURL that the request was targeting."
},
{
"name": "raw_payload",
"type": "str | None",
"description": "if the timeout is tied to a specific request, this is the\nassociated payload (as a string)."
}
]
}
|
astrapy.exceptions.DataAPITimeoutException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DataAPITimeoutException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPITimeoutException.timeout_type
|
{
"kind": "attribute",
"name": "timeout_type",
"path": "astrapy.exceptions.DataAPITimeoutException.timeout_type",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "timeout_type: str = timeout_type",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPITimeoutException.endpoint
|
{
"kind": "attribute",
"name": "endpoint",
"path": "astrapy.exceptions.DataAPITimeoutException.endpoint",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "endpoint: str | None = endpoint",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPITimeoutException.raw_payload
|
{
"kind": "attribute",
"name": "raw_payload",
"path": "astrapy.exceptions.DataAPITimeoutException.raw_payload",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_payload: str | None = raw_payload",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.CursorIsStartedException
|
The cursor operation cannot be invoked if a cursor is not in its pristine
state (i.e. is already being consumed or is exhausted altogether).
|
{
"kind": "class",
"name": "CursorIsStartedException",
"path": "astrapy.exceptions.CursorIsStartedException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "cursor_state",
"type": "str",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"DataAPIException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str",
"description": "a text message about the exception."
},
{
"name": "cursor_state",
"type": "str",
"description": "a string description of the current state\nof the cursor. See the documentation for Cursor."
}
]
}
|
astrapy.exceptions.CursorIsStartedException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.CursorIsStartedException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.CursorIsStartedException.cursor_state
|
{
"kind": "attribute",
"name": "cursor_state",
"path": "astrapy.exceptions.CursorIsStartedException.cursor_state",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "cursor_state: str = cursor_state",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.CollectionNotFoundException
|
A collection is found non-existing and the requested operation
cannot be performed.
|
{
"kind": "class",
"name": "CollectionNotFoundException",
"path": "astrapy.exceptions.CollectionNotFoundException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "keyspace",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "collection_name",
"type": "str",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"DataAPIException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str",
"description": "a text message about the exception."
},
{
"name": "keyspace",
"type": "str",
"description": "the keyspace where the collection was supposed to be."
},
{
"name": "namespace",
"type": "str",
"description": "an alias for 'keyspace'. *DEPRECATED*, removal in 2.0"
},
{
"name": "collection_name",
"type": "str",
"description": "the name of the expected collection."
}
]
}
|
astrapy.exceptions.CollectionNotFoundException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.CollectionNotFoundException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.CollectionNotFoundException.keyspace
|
{
"kind": "attribute",
"name": "keyspace",
"path": "astrapy.exceptions.CollectionNotFoundException.keyspace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "keyspace: str = keyspace",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.CollectionNotFoundException.namespace
|
{
"kind": "attribute",
"name": "namespace",
"path": "astrapy.exceptions.CollectionNotFoundException.namespace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "namespace: str = keyspace",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.CollectionNotFoundException.collection_name
|
{
"kind": "attribute",
"name": "collection_name",
"path": "astrapy.exceptions.CollectionNotFoundException.collection_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "collection_name: str = collection_name",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.CollectionAlreadyExistsException
|
An operation expected a collection not to exist, yet it has
been detected as pre-existing.
|
{
"kind": "class",
"name": "CollectionAlreadyExistsException",
"path": "astrapy.exceptions.CollectionAlreadyExistsException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "keyspace",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "collection_name",
"type": "str",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"DataAPIException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str",
"description": "a text message about the exception."
},
{
"name": "keyspace",
"type": "str",
"description": "the keyspace where the collection was expected not to exist."
},
{
"name": "namespace",
"type": "str",
"description": "an alias for 'keyspace'. *DEPRECATED*, removal in 2.0"
},
{
"name": "collection_name",
"type": "str",
"description": "the name of the collection."
}
]
}
|
astrapy.exceptions.CollectionAlreadyExistsException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.CollectionAlreadyExistsException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.CollectionAlreadyExistsException.keyspace
|
{
"kind": "attribute",
"name": "keyspace",
"path": "astrapy.exceptions.CollectionAlreadyExistsException.keyspace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "keyspace: str = keyspace",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.CollectionAlreadyExistsException.namespace
|
{
"kind": "attribute",
"name": "namespace",
"path": "astrapy.exceptions.CollectionAlreadyExistsException.namespace",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "namespace: str = keyspace",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.CollectionAlreadyExistsException.collection_name
|
{
"kind": "attribute",
"name": "collection_name",
"path": "astrapy.exceptions.CollectionAlreadyExistsException.collection_name",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "collection_name: str = collection_name",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.TooManyDocumentsToCountException
|
A `count_documents()` operation failed because the resulting number of documents
exceeded either the upper bound set by the caller or the hard limit imposed
by the Data API.
|
{
"kind": "class",
"name": "TooManyDocumentsToCountException",
"path": "astrapy.exceptions.TooManyDocumentsToCountException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "server_max_count_exceeded",
"type": "bool",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"DataAPIException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str",
"description": "a text message about the exception."
},
{
"name": "server_max_count_exceeded",
"type": "bool",
"description": "True if the count limit imposed by the API\nis reached. In that case, increasing the upper bound in the method\ninvocation is of no help."
}
]
}
|
astrapy.exceptions.TooManyDocumentsToCountException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.TooManyDocumentsToCountException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.TooManyDocumentsToCountException.server_max_count_exceeded
|
{
"kind": "attribute",
"name": "server_max_count_exceeded",
"path": "astrapy.exceptions.TooManyDocumentsToCountException.server_max_count_exceeded",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "server_max_count_exceeded: bool = server_max_count_exceeded",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIFaultyResponseException
|
The Data API response is malformed in that it does not have
expected field(s), or they are of the wrong type.
|
{
"kind": "class",
"name": "DataAPIFaultyResponseException",
"path": "astrapy.exceptions.DataAPIFaultyResponseException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_response",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"DataAPIException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str",
"description": "a text message about the exception."
},
{
"name": "raw_response",
"type": "dict[str, Any] | None",
"description": "the response returned by the API in the form of a dict."
}
]
}
|
astrapy.exceptions.DataAPIFaultyResponseException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DataAPIFaultyResponseException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIFaultyResponseException.raw_response
|
{
"kind": "attribute",
"name": "raw_response",
"path": "astrapy.exceptions.DataAPIFaultyResponseException.raw_response",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "raw_response: dict[str, Any] | None = raw_response",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIResponseException
|
The Data API returned an HTTP 200 success response, which however
reports about API-specific error(s), possibly alongside partial successes.
This exception is related to an operation that can have spanned several
HTTP requests in sequence (e.g. a chunked insert_many). For this
reason, it should be not thought as being in a 1:1 relation with
actual API requests, rather with operations invoked by the user,
such as the methods of the Collection object.
|
{
"kind": "class",
"name": "DataAPIResponseException",
"path": "astrapy.exceptions.DataAPIResponseException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": null,
"default": null,
"value": null
},
{
"name": "detailed_error_descriptors",
"type": "list[DataAPIDetailedErrorDescriptor]",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIDetailedErrorDescriptor",
"DataAPIErrorDescriptor",
"DataAPIException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"DataAPIException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": [
"astrapy.exceptions.CumulativeOperationException",
"astrapy.exceptions.BulkWriteException"
],
"attributes": [
{
"name": "text",
"type": "str | None",
"description": "a text message about the exception."
},
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": "a list of all DataAPIErrorDescriptor objects\nfound across all requests involved in this exception, which are\npossibly more than one."
},
{
"name": "detailed_error_descriptors",
"type": "list[DataAPIDetailedErrorDescriptor]",
"description": "a list of DataAPIDetailedErrorDescriptor\nobjects, one for each of the requests performed during this operation.\nFor single-request methods, such as insert_one, this list always\nhas a single element."
}
]
}
|
astrapy.exceptions.DataAPIResponseException.text
|
{
"kind": "attribute",
"name": "text",
"path": "astrapy.exceptions.DataAPIResponseException.text",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "text: str | None = text",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIResponseException.error_descriptors
|
{
"kind": "attribute",
"name": "error_descriptors",
"path": "astrapy.exceptions.DataAPIResponseException.error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DataAPIErrorDescriptor"
],
"value": "error_descriptors: list[DataAPIErrorDescriptor] = error_descriptors",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIResponseException.detailed_error_descriptors
|
{
"kind": "attribute",
"name": "detailed_error_descriptors",
"path": "astrapy.exceptions.DataAPIResponseException.detailed_error_descriptors",
"parameters": null,
"returns": null,
"gathered_types": [
"DataAPIDetailedErrorDescriptor"
],
"value": "detailed_error_descriptors: list[DataAPIDetailedErrorDescriptor] = detailed_error_descriptors",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DataAPIResponseException.from_response
|
Parse a raw response from the API into this exception.
|
{
"kind": "function",
"name": "from_response",
"path": "astrapy.exceptions.DataAPIResponseException.from_response",
"parameters": [
{
"name": "cls",
"type": null,
"description": null,
"default": null,
"value": null
},
{
"name": "command",
"type": "dict[str, Any] | None",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_response",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "kwargs",
"type": "Any",
"description": null,
"default": "{}",
"value": null
}
],
"returns": [
{
"name": null,
"type": "DataAPIResponseException",
"description": null
}
],
"gathered_types": [
"astrapy.exceptions.DataAPIResponseException"
],
"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.DataAPIResponseException.from_responses
|
Parse a list of raw responses from the API into this exception.
|
{
"kind": "function",
"name": "from_responses",
"path": "astrapy.exceptions.DataAPIResponseException.from_responses",
"parameters": [
{
"name": "cls",
"type": null,
"description": null,
"default": null,
"value": null
},
{
"name": "commands",
"type": "list[dict[str, Any] | None]",
"description": null,
"default": null,
"value": null
},
{
"name": "raw_responses",
"type": "list[dict[str, Any]]",
"description": null,
"default": null,
"value": null
},
{
"name": "kwargs",
"type": "Any",
"description": null,
"default": "{}",
"value": null
}
],
"returns": [
{
"name": null,
"type": "DataAPIResponseException",
"description": null
}
],
"gathered_types": [
"astrapy.exceptions.DataAPIResponseException"
],
"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.DataAPIResponseException.data_api_response_exception
|
Cast the exception, whatever the subclass, into this parent superclass.
|
{
"kind": "function",
"name": "data_api_response_exception",
"path": "astrapy.exceptions.DataAPIResponseException.data_api_response_exception",
"parameters": null,
"returns": [
{
"name": null,
"type": "DataAPIResponseException",
"description": null
}
],
"gathered_types": [
"astrapy.exceptions.DataAPIResponseException"
],
"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.CumulativeOperationException
|
An exception of type DataAPIResponseException (see) occurred
during an operation that in general spans several requests.
As such, besides information on the error, it may have accumulated
a partial result from past successful Data API requests.
|
{
"kind": "class",
"name": "CumulativeOperationException",
"path": "astrapy.exceptions.CumulativeOperationException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": null,
"default": null,
"value": null
},
{
"name": "detailed_error_descriptors",
"type": "list[DataAPIDetailedErrorDescriptor]",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIDetailedErrorDescriptor",
"astrapy.exceptions.DataAPIResponseException",
"DataAPIErrorDescriptor",
"astrapy.results.OperationResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.exceptions.DataAPIResponseException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": [
"astrapy.exceptions.InsertManyException",
"astrapy.exceptions.DeleteManyException",
"astrapy.exceptions.UpdateManyException"
],
"attributes": [
{
"name": "text",
"type": "str | None",
"description": "a text message about the exception."
},
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": "a list of all DataAPIErrorDescriptor objects\nfound across all requests involved in this exception, which are\npossibly more than one."
},
{
"name": "detailed_error_descriptors",
"type": "list[DataAPIDetailedErrorDescriptor]",
"description": "a list of DataAPIDetailedErrorDescriptor\nobjects, one for each of the requests performed during this operation.\nFor single-request methods, such as insert_one, this list always\nhas a single element."
},
{
"name": "partial_result",
"type": "OperationResult",
"description": "an OperationResult object, just like the one that would\nbe the return value of the operation, had it succeeded completely."
}
]
}
|
astrapy.exceptions.CumulativeOperationException.partial_result
|
{
"kind": "attribute",
"name": "partial_result",
"path": "astrapy.exceptions.CumulativeOperationException.partial_result",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.results.OperationResult"
],
"value": "partial_result: OperationResult",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.InsertManyException
|
An exception of type DataAPIResponseException (see) occurred
during an insert_many (that in general spans several requests).
As such, besides information on the error, it may have accumulated
a partial result from past successful Data API requests.
|
{
"kind": "class",
"name": "InsertManyException",
"path": "astrapy.exceptions.InsertManyException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "partial_result",
"type": "InsertManyResult",
"description": null,
"default": null,
"value": null
},
{
"name": "pargs",
"type": "Any",
"description": null,
"default": "()",
"value": null
},
{
"name": "kwargs",
"type": "Any",
"description": null,
"default": "{}",
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIDetailedErrorDescriptor",
"DataAPIErrorDescriptor",
"astrapy.exceptions.CumulativeOperationException",
"astrapy.results.InsertManyResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.exceptions.CumulativeOperationException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str | None",
"description": "a text message about the exception."
},
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": "a list of all DataAPIErrorDescriptor objects\nfound across all requests involved in this exception, which are\npossibly more than one."
},
{
"name": "detailed_error_descriptors",
"type": "list[DataAPIDetailedErrorDescriptor]",
"description": "a list of DataAPIDetailedErrorDescriptor\nobjects, one for each of the requests performed during this operation.\nFor single-request methods, such as insert_one, this list always\nhas a single element."
},
{
"name": "partial_result",
"type": "InsertManyResult",
"description": "an InsertManyResult object, just like the one that would\nbe the return value of the operation, had it succeeded completely."
}
]
}
|
astrapy.exceptions.InsertManyException.partial_result
|
{
"kind": "attribute",
"name": "partial_result",
"path": "astrapy.exceptions.InsertManyException.partial_result",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.results.InsertManyResult"
],
"value": "partial_result: InsertManyResult = partial_result",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.DeleteManyException
|
An exception of type DataAPIResponseException (see) occurred
during a delete_many (that in general spans several requests).
As such, besides information on the error, it may have accumulated
a partial result from past successful Data API requests.
|
{
"kind": "class",
"name": "DeleteManyException",
"path": "astrapy.exceptions.DeleteManyException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "partial_result",
"type": "DeleteResult",
"description": null,
"default": null,
"value": null
},
{
"name": "pargs",
"type": "Any",
"description": null,
"default": "()",
"value": null
},
{
"name": "kwargs",
"type": "Any",
"description": null,
"default": "{}",
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIDetailedErrorDescriptor",
"astrapy.results.DeleteResult",
"DataAPIErrorDescriptor",
"astrapy.exceptions.CumulativeOperationException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.exceptions.CumulativeOperationException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str | None",
"description": "a text message about the exception."
},
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": "a list of all DataAPIErrorDescriptor objects\nfound across all requests involved in this exception, which are\npossibly more than one."
},
{
"name": "detailed_error_descriptors",
"type": "list[DataAPIDetailedErrorDescriptor]",
"description": "a list of DataAPIDetailedErrorDescriptor\nobjects, one for each of the requests performed during this operation.\nFor single-request methods, such as insert_one, this list always\nhas a single element."
},
{
"name": "partial_result",
"type": "DeleteResult",
"description": "a DeleteResult object, just like the one that would\nbe the return value of the operation, had it succeeded completely."
}
]
}
|
astrapy.exceptions.DeleteManyException.partial_result
|
{
"kind": "attribute",
"name": "partial_result",
"path": "astrapy.exceptions.DeleteManyException.partial_result",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.results.DeleteResult"
],
"value": "partial_result: DeleteResult = partial_result",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.UpdateManyException
|
An exception of type DataAPIResponseException (see) occurred
during an update_many (that in general spans several requests).
As such, besides information on the error, it may have accumulated
a partial result from past successful Data API requests.
|
{
"kind": "class",
"name": "UpdateManyException",
"path": "astrapy.exceptions.UpdateManyException",
"parameters": [
{
"name": "text",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "partial_result",
"type": "UpdateResult",
"description": null,
"default": null,
"value": null
},
{
"name": "pargs",
"type": "Any",
"description": null,
"default": "()",
"value": null
},
{
"name": "kwargs",
"type": "Any",
"description": null,
"default": "{}",
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIDetailedErrorDescriptor",
"astrapy.results.UpdateResult",
"DataAPIErrorDescriptor",
"astrapy.exceptions.CumulativeOperationException"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.exceptions.CumulativeOperationException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str | None",
"description": "a text message about the exception."
},
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": "a list of all DataAPIErrorDescriptor objects\nfound across all requests involved in this exception, which are\npossibly more than one."
},
{
"name": "detailed_error_descriptors",
"type": "list[DataAPIDetailedErrorDescriptor]",
"description": "a list of DataAPIDetailedErrorDescriptor\nobjects, one for each of the requests performed during this operation.\nFor single-request methods, such as insert_one, this list always\nhas a single element."
},
{
"name": "partial_result",
"type": "UpdateResult",
"description": "an UpdateResult object, just like the one that would\nbe the return value of the operation, had it succeeded completely."
}
]
}
|
astrapy.exceptions.UpdateManyException.partial_result
|
{
"kind": "attribute",
"name": "partial_result",
"path": "astrapy.exceptions.UpdateManyException.partial_result",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.results.UpdateResult"
],
"value": "partial_result: UpdateResult = partial_result",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.BulkWriteException
|
An exception of type DataAPIResponseException (see) occurred
during a bulk_write of a list of operations.
As such, besides information on the error, it may have accumulated
a partial result from past successful operations.
|
{
"kind": "class",
"name": "BulkWriteException",
"path": "astrapy.exceptions.BulkWriteException",
"parameters": [
{
"name": "text",
"type": "str | None",
"description": null,
"default": null,
"value": null
},
{
"name": "partial_result",
"type": "BulkWriteResult",
"description": null,
"default": null,
"value": null
},
{
"name": "exceptions",
"type": "list[DataAPIResponseException]",
"description": null,
"default": null,
"value": null
},
{
"name": "pargs",
"type": "Any",
"description": null,
"default": "()",
"value": null
},
{
"name": "kwargs",
"type": "Any",
"description": null,
"default": "{}",
"value": null
}
],
"returns": null,
"gathered_types": [
"DataAPIDetailedErrorDescriptor",
"DataAPIErrorDescriptor",
"astrapy.exceptions.DataAPIResponseException",
"astrapy.results.BulkWriteResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.exceptions.DataAPIResponseException"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "text",
"type": "str | None",
"description": "a text message about the exception."
},
{
"name": "error_descriptors",
"type": "list[DataAPIErrorDescriptor]",
"description": "a list of all DataAPIErrorDescriptor objects\nfound across all requests involved in the first\noperation that has failed."
},
{
"name": "detailed_error_descriptors",
"type": "list[DataAPIDetailedErrorDescriptor]",
"description": "a list of DataAPIDetailedErrorDescriptor\nobjects, one for each of the requests performed during the first operation\nthat has failed."
},
{
"name": "partial_result",
"type": "BulkWriteResult",
"description": "a BulkWriteResult object, just like the one that would\nbe the return value of the operation, had it succeeded completely."
},
{
"name": "exceptions",
"type": "list[DataAPIResponseException]",
"description": "a list of DataAPIResponseException objects, one for each\noperation in the bulk that has failed. This information is made\navailable here since the top-level fields of this error\nonly surface the first such failure that is detected across the bulk.\nIn case of bulk_writes with ordered=True, this trivially contains\na single element, the same described by the top-level fields\ntext, error_descriptors and detailed_error_descriptors."
}
]
}
|
astrapy.exceptions.BulkWriteException.partial_result
|
{
"kind": "attribute",
"name": "partial_result",
"path": "astrapy.exceptions.BulkWriteException.partial_result",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.results.BulkWriteResult"
],
"value": "partial_result: BulkWriteResult = partial_result",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.BulkWriteException.exceptions
|
{
"kind": "attribute",
"name": "exceptions",
"path": "astrapy.exceptions.BulkWriteException.exceptions",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.exceptions.DataAPIResponseException"
],
"value": "exceptions: list[DataAPIResponseException] = exceptions",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.to_dataapi_timeout_exception
|
{
"kind": "function",
"name": "to_dataapi_timeout_exception",
"path": "astrapy.exceptions.to_dataapi_timeout_exception",
"parameters": [
{
"name": "httpx_timeout",
"type": "httpx.TimeoutException",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "DataAPITimeoutException",
"description": null
}
],
"gathered_types": [
"astrapy.exceptions.DataAPITimeoutException",
"TimeoutException"
],
"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.to_devopsapi_timeout_exception
|
{
"kind": "function",
"name": "to_devopsapi_timeout_exception",
"path": "astrapy.exceptions.to_devopsapi_timeout_exception",
"parameters": [
{
"name": "httpx_timeout",
"type": "httpx.TimeoutException",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "DevOpsAPITimeoutException",
"description": null
}
],
"gathered_types": [
"DevOpsAPITimeoutException",
"TimeoutException"
],
"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.base_timeout_info
|
{
"kind": "function",
"name": "base_timeout_info",
"path": "astrapy.exceptions.base_timeout_info",
"parameters": [
{
"name": "max_time_ms",
"type": "int | None",
"description": null,
"default": null,
"value": 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.exceptions.MultiCallTimeoutManager
|
A helper class to keep track of timing and timeouts
in a multi-call method context.
|
{
"kind": "class",
"name": "MultiCallTimeoutManager",
"path": "astrapy.exceptions.MultiCallTimeoutManager",
"parameters": [
{
"name": "overall_max_time_ms",
"type": "int | None",
"description": "an optional max duration to track (milliseconds)",
"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": null,
"implemented_by": null,
"attributes": [
{
"name": "overall_max_time_ms",
"type": "int | None",
"description": "an optional max duration to track (milliseconds)"
},
{
"name": "started_ms",
"type": "int",
"description": "timestamp of the instance construction (milliseconds)"
},
{
"name": "deadline_ms",
"type": "int | None",
"description": "optional deadline in milliseconds (computed by the class)."
}
]
}
|
astrapy.exceptions.MultiCallTimeoutManager.overall_max_time_ms
|
{
"kind": "attribute",
"name": "overall_max_time_ms",
"path": "astrapy.exceptions.MultiCallTimeoutManager.overall_max_time_ms",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "overall_max_time_ms: int | None = overall_max_time_ms",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.MultiCallTimeoutManager.started_ms
|
{
"kind": "attribute",
"name": "started_ms",
"path": "astrapy.exceptions.MultiCallTimeoutManager.started_ms",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "started_ms: int = int(time.time() * 1000)",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.MultiCallTimeoutManager.deadline_ms
|
{
"kind": "attribute",
"name": "deadline_ms",
"path": "astrapy.exceptions.MultiCallTimeoutManager.deadline_ms",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "deadline_ms: int | None",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.exceptions.MultiCallTimeoutManager.dev_ops_api
|
{
"kind": "attribute",
"name": "dev_ops_api",
"path": "astrapy.exceptions.MultiCallTimeoutManager.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
}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.