id
stringlengths 7
77
| text
stringlengths 0
3.4k
| metadata
dict |
|---|---|---|
astrapy.operations.InsertOne.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.InsertOne.execute",
"parameters": [
{
"name": "collection",
"type": "Collection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.InsertMany
|
Represents an `insert_many` operation on a (sync) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "InsertMany",
"path": "astrapy.operations.InsertMany",
"parameters": [
{
"name": "documents",
"type": "Iterable[DocumentType]",
"description": null,
"default": null,
"value": null
},
{
"name": "vectors",
"type": "Iterable[VectorType | None] | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "vectorize",
"type": "Iterable[str | None] | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "ordered",
"type": "bool",
"description": null,
"default": "True",
"value": null
},
{
"name": "chunk_size",
"type": "int | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "concurrency",
"type": "int | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType",
"astrapy.constants.DocumentType",
"astrapy.operations.BaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.BaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "documents",
"type": "Iterable[DocumentType]",
"description": "the list document to insert."
},
{
"name": "vectors",
"type": "Iterable[VectorType | None] | None",
"description": "an optional list of vectors to enrich the documents at insertion.\n*DEPRECATED* (removal in 2.0). Use a `$vector` key in the documents instead."
},
{
"name": "vectorize",
"type": "Iterable[str | None] | None",
"description": "an optional list of texts achieving the same effect as `vectors`\nexcept through an embedding service, if one is configured for the collection.\n*DEPRECATED* (removal in 2.0). Use a `$vectorize` key in the documents instead."
},
{
"name": "ordered",
"type": "bool",
"description": "whether the inserts should be done in sequence."
},
{
"name": "chunk_size",
"type": "int | None",
"description": "how many documents to include in a single API request.\nExceeding the server maximum allowed value results in an error.\nLeave it unspecified (recommended) to use the system default."
},
{
"name": "concurrency",
"type": "int | None",
"description": "maximum number of concurrent requests to the API at\na given time. It cannot be more than one for ordered insertions."
}
]
}
|
astrapy.operations.InsertMany.documents
|
{
"kind": "attribute",
"name": "documents",
"path": "astrapy.operations.InsertMany.documents",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.DocumentType"
],
"value": "documents: Iterable[DocumentType] = documents",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.InsertMany.vectors
|
{
"kind": "attribute",
"name": "vectors",
"path": "astrapy.operations.InsertMany.vectors",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType"
],
"value": "vectors: Iterable[VectorType | None] | None = vectors",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.InsertMany.vectorize
|
{
"kind": "attribute",
"name": "vectorize",
"path": "astrapy.operations.InsertMany.vectorize",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "vectorize: Iterable[str | None] | None = vectorize",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.InsertMany.ordered
|
{
"kind": "attribute",
"name": "ordered",
"path": "astrapy.operations.InsertMany.ordered",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "ordered: bool = ordered",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.InsertMany.chunk_size
|
{
"kind": "attribute",
"name": "chunk_size",
"path": "astrapy.operations.InsertMany.chunk_size",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "chunk_size: int | None = chunk_size",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.InsertMany.concurrency
|
{
"kind": "attribute",
"name": "concurrency",
"path": "astrapy.operations.InsertMany.concurrency",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "concurrency: int | None = concurrency",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.InsertMany.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.InsertMany.execute",
"parameters": [
{
"name": "collection",
"type": "Collection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.UpdateOne
|
Represents an `update_one` operation on a (sync) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "UpdateOne",
"path": "astrapy.operations.UpdateOne",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "update",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "vector",
"type": "VectorType | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "vectorize",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "sort",
"type": "SortType | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "upsert",
"type": "bool",
"description": null,
"default": "False",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType",
"astrapy.constants.SortType",
"astrapy.operations.BaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.BaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "a filter condition to select a target document."
},
{
"name": "update",
"type": "dict[str, Any]",
"description": "an update prescription to apply to the document."
},
{
"name": "vector",
"type": "VectorType | None",
"description": "a vector of numbers to use for ANN (vector-search) sorting.\n*DEPRECATED* (removal in 2.0). Use a `$vector` key in the\nsort clause dict instead."
},
{
"name": "vectorize",
"type": "str | None",
"description": "a string to be made into a vector, with the same result as the\n`vector` attribute, through an embedding service, assuming one is\nconfigured for the collection.\n*DEPRECATED* (removal in 2.0). Use a `$vectorize` key in the\nsort clause dict instead."
},
{
"name": "sort",
"type": "SortType | None",
"description": "controls ordering of results, hence which document is affected."
},
{
"name": "upsert",
"type": "bool",
"description": "controls what to do when no documents are found."
}
]
}
|
astrapy.operations.UpdateOne.filter
|
{
"kind": "attribute",
"name": "filter",
"path": "astrapy.operations.UpdateOne.filter",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "filter: dict[str, Any] = filter",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.UpdateOne.update
|
{
"kind": "attribute",
"name": "update",
"path": "astrapy.operations.UpdateOne.update",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "update: dict[str, Any] = update",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.UpdateOne.vector
|
{
"kind": "attribute",
"name": "vector",
"path": "astrapy.operations.UpdateOne.vector",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType"
],
"value": "vector: VectorType | None = vector",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.UpdateOne.vectorize
|
{
"kind": "attribute",
"name": "vectorize",
"path": "astrapy.operations.UpdateOne.vectorize",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "vectorize: str | None = vectorize",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.UpdateOne.sort
|
{
"kind": "attribute",
"name": "sort",
"path": "astrapy.operations.UpdateOne.sort",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.SortType"
],
"value": "sort: SortType | None = sort",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.UpdateOne.upsert
|
{
"kind": "attribute",
"name": "upsert",
"path": "astrapy.operations.UpdateOne.upsert",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "upsert: bool = upsert",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.UpdateOne.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.UpdateOne.execute",
"parameters": [
{
"name": "collection",
"type": "Collection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.UpdateMany
|
Represents an `update_many` operation on a (sync) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "UpdateMany",
"path": "astrapy.operations.UpdateMany",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "update",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "upsert",
"type": "bool",
"description": null,
"default": "False",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.operations.BaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.BaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "a filter condition to select target documents."
},
{
"name": "update",
"type": "dict[str, Any]",
"description": "an update prescription to apply to the documents."
},
{
"name": "upsert",
"type": "bool",
"description": "controls what to do when no documents are found."
}
]
}
|
astrapy.operations.UpdateMany.filter
|
{
"kind": "attribute",
"name": "filter",
"path": "astrapy.operations.UpdateMany.filter",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "filter: dict[str, Any] = filter",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.UpdateMany.update
|
{
"kind": "attribute",
"name": "update",
"path": "astrapy.operations.UpdateMany.update",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "update: dict[str, Any] = update",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.UpdateMany.upsert
|
{
"kind": "attribute",
"name": "upsert",
"path": "astrapy.operations.UpdateMany.upsert",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "upsert: bool = upsert",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.UpdateMany.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.UpdateMany.execute",
"parameters": [
{
"name": "collection",
"type": "Collection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.ReplaceOne
|
Represents a `replace_one` operation on a (sync) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "ReplaceOne",
"path": "astrapy.operations.ReplaceOne",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "replacement",
"type": "DocumentType",
"description": null,
"default": null,
"value": null
},
{
"name": "vector",
"type": "VectorType | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "vectorize",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "sort",
"type": "SortType | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "upsert",
"type": "bool",
"description": null,
"default": "False",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType",
"astrapy.constants.DocumentType",
"astrapy.constants.SortType",
"astrapy.operations.BaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.BaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "a filter condition to select a target document."
},
{
"name": "replacement",
"type": "DocumentType",
"description": "the replacement document."
},
{
"name": "vector",
"type": "VectorType | None",
"description": "a vector of numbers to use for ANN (vector-search) sorting.\n*DEPRECATED* (removal in 2.0). Use a `$vector` key in the\nsort clause dict instead."
},
{
"name": "vectorize",
"type": "str | None",
"description": "a string to be made into a vector, with the same result as the\n`vector` attribute, through an embedding service, assuming one is\nconfigured for the collection.\n*DEPRECATED* (removal in 2.0). Use a `$vectorize` key in the\nsort clause dict instead."
},
{
"name": "sort",
"type": "SortType | None",
"description": "controls ordering of results, hence which document is affected."
},
{
"name": "upsert",
"type": "bool",
"description": "controls what to do when no documents are found."
}
]
}
|
astrapy.operations.ReplaceOne.filter
|
{
"kind": "attribute",
"name": "filter",
"path": "astrapy.operations.ReplaceOne.filter",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "filter: dict[str, Any] = filter",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.ReplaceOne.replacement
|
{
"kind": "attribute",
"name": "replacement",
"path": "astrapy.operations.ReplaceOne.replacement",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.DocumentType"
],
"value": "replacement: DocumentType = replacement",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.ReplaceOne.vector
|
{
"kind": "attribute",
"name": "vector",
"path": "astrapy.operations.ReplaceOne.vector",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType"
],
"value": "vector: VectorType | None = vector",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.ReplaceOne.vectorize
|
{
"kind": "attribute",
"name": "vectorize",
"path": "astrapy.operations.ReplaceOne.vectorize",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "vectorize: str | None = vectorize",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.ReplaceOne.sort
|
{
"kind": "attribute",
"name": "sort",
"path": "astrapy.operations.ReplaceOne.sort",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.SortType"
],
"value": "sort: SortType | None = sort",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.ReplaceOne.upsert
|
{
"kind": "attribute",
"name": "upsert",
"path": "astrapy.operations.ReplaceOne.upsert",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "upsert: bool = upsert",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.ReplaceOne.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.ReplaceOne.execute",
"parameters": [
{
"name": "collection",
"type": "Collection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.DeleteOne
|
Represents a `delete_one` operation on a (sync) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "DeleteOne",
"path": "astrapy.operations.DeleteOne",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "vector",
"type": "VectorType | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "vectorize",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "sort",
"type": "SortType | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType",
"astrapy.constants.SortType",
"astrapy.operations.BaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.BaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "a filter condition to select a target document."
},
{
"name": "vector",
"type": "VectorType | None",
"description": "a vector of numbers to use for ANN (vector-search) sorting.\n*DEPRECATED* (removal in 2.0). Use a `$vector` key in the\nsort clause dict instead."
},
{
"name": "vectorize",
"type": "str | None",
"description": "a string to be made into a vector, with the same result as the\n`vector` attribute, through an embedding service, assuming one is\nconfigured for the collection.\n*DEPRECATED* (removal in 2.0). Use a `$vectorize` key in the\nsort clause dict instead."
},
{
"name": "sort",
"type": "SortType | None",
"description": "controls ordering of results, hence which document is affected."
}
]
}
|
astrapy.operations.DeleteOne.filter
|
{
"kind": "attribute",
"name": "filter",
"path": "astrapy.operations.DeleteOne.filter",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "filter: dict[str, Any] = filter",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.DeleteOne.vector
|
{
"kind": "attribute",
"name": "vector",
"path": "astrapy.operations.DeleteOne.vector",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType"
],
"value": "vector: VectorType | None = vector",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.DeleteOne.vectorize
|
{
"kind": "attribute",
"name": "vectorize",
"path": "astrapy.operations.DeleteOne.vectorize",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "vectorize: str | None = vectorize",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.DeleteOne.sort
|
{
"kind": "attribute",
"name": "sort",
"path": "astrapy.operations.DeleteOne.sort",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.SortType"
],
"value": "sort: SortType | None = sort",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.DeleteOne.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.DeleteOne.execute",
"parameters": [
{
"name": "collection",
"type": "Collection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.DeleteMany
|
Represents a `delete_many` operation on a (sync) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "DeleteMany",
"path": "astrapy.operations.DeleteMany",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.operations.BaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.BaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "a filter condition to select target documents."
}
]
}
|
astrapy.operations.DeleteMany.filter
|
{
"kind": "attribute",
"name": "filter",
"path": "astrapy.operations.DeleteMany.filter",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "filter: dict[str, Any] = filter",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.DeleteMany.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.DeleteMany.execute",
"parameters": [
{
"name": "collection",
"type": "Collection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.AsyncBaseOperation
|
Base class for all operations amenable to be used
in bulk writes on (async) collections.
|
{
"kind": "class",
"name": "AsyncBaseOperation",
"path": "astrapy.operations.AsyncBaseOperation",
"parameters": null,
"returns": null,
"gathered_types": [
"ABC"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"ABC"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": [
"astrapy.operations.AsyncInsertMany",
"astrapy.operations.AsyncDeleteMany",
"astrapy.operations.AsyncInsertOne",
"astrapy.operations.AsyncUpdateMany",
"astrapy.operations.AsyncReplaceOne",
"astrapy.operations.AsyncDeleteOne",
"astrapy.operations.AsyncUpdateOne"
],
"attributes": null
}
|
astrapy.operations.AsyncBaseOperation.execute
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.AsyncBaseOperation.execute",
"parameters": [
{
"name": "collection",
"type": "AsyncCollection",
"description": null,
"default": null,
"value": null
},
{
"name": "index_in_bulk_write",
"type": "int",
"description": null,
"default": null,
"value": null
},
{
"name": "bulk_write_timeout_ms",
"type": "int | None",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult",
"astrapy.collection.AsyncCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncInsertOne
|
Represents an `insert_one` operation on a (async) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "AsyncInsertOne",
"path": "astrapy.operations.AsyncInsertOne",
"parameters": [
{
"name": "document",
"type": "DocumentType",
"description": null,
"default": null,
"value": null
},
{
"name": "vector",
"type": "VectorType | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "vectorize",
"type": "str | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType",
"astrapy.constants.DocumentType",
"astrapy.operations.AsyncBaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.AsyncBaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "document",
"type": "DocumentType",
"description": "the document to insert."
},
{
"name": "vector",
"type": "VectorType | None",
"description": "an optional suitable vector to enrich the document at insertion.\n*DEPRECATED* (removal in 2.0). Use a `$vector` key in the document instead."
},
{
"name": "vectorize",
"type": "str | None",
"description": "a string to be made into a vector, with the same result as the\n`vector` attribute, through an embedding service, assuming one is\nconfigured for the collection.\n*DEPRECATED* (removal in 2.0). Use a `$vectorize` key in the document instead."
}
]
}
|
astrapy.operations.AsyncInsertOne.document
|
{
"kind": "attribute",
"name": "document",
"path": "astrapy.operations.AsyncInsertOne.document",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.DocumentType"
],
"value": "document: DocumentType = document",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncInsertOne.vector
|
{
"kind": "attribute",
"name": "vector",
"path": "astrapy.operations.AsyncInsertOne.vector",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType"
],
"value": "vector: VectorType | None = vector",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncInsertOne.vectorize
|
{
"kind": "attribute",
"name": "vectorize",
"path": "astrapy.operations.AsyncInsertOne.vectorize",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "vectorize: str | None = vectorize",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncInsertOne.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.AsyncInsertOne.execute",
"parameters": [
{
"name": "collection",
"type": "AsyncCollection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult",
"astrapy.collection.AsyncCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.AsyncInsertMany
|
Represents an `insert_many` operation on a (async) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "AsyncInsertMany",
"path": "astrapy.operations.AsyncInsertMany",
"parameters": [
{
"name": "documents",
"type": "Iterable[DocumentType]",
"description": null,
"default": null,
"value": null
},
{
"name": "vectors",
"type": "Iterable[VectorType | None] | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "vectorize",
"type": "Iterable[str | None] | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "ordered",
"type": "bool",
"description": null,
"default": "True",
"value": null
},
{
"name": "chunk_size",
"type": "int | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "concurrency",
"type": "int | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType",
"astrapy.constants.DocumentType",
"astrapy.operations.AsyncBaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.AsyncBaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "documents",
"type": "Iterable[DocumentType]",
"description": "the list document to insert."
},
{
"name": "vectors",
"type": "Iterable[VectorType | None] | None",
"description": "an optional list of vectors to enrich the documents at insertion.\n*DEPRECATED* (removal in 2.0). Use a `$vector` key in the documents instead."
},
{
"name": "vectorize",
"type": "Iterable[str | None] | None",
"description": "an optional list of texts achieving the same effect as `vectors`\nexcept through an embedding service, if one is configured for the collection.\n*DEPRECATED* (removal in 2.0). Use a `$vectorize` key in the documents instead."
},
{
"name": "ordered",
"type": "bool",
"description": "whether the inserts should be done in sequence."
},
{
"name": "chunk_size",
"type": "int | None",
"description": "how many documents to include in a single API request.\nExceeding the server maximum allowed value results in an error.\nLeave it unspecified (recommended) to use the system default."
},
{
"name": "concurrency",
"type": "int | None",
"description": "maximum number of concurrent requests to the API at\na given time. It cannot be more than one for ordered insertions."
}
]
}
|
astrapy.operations.AsyncInsertMany.documents
|
{
"kind": "attribute",
"name": "documents",
"path": "astrapy.operations.AsyncInsertMany.documents",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.DocumentType"
],
"value": "documents: Iterable[DocumentType] = documents",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncInsertMany.vectors
|
{
"kind": "attribute",
"name": "vectors",
"path": "astrapy.operations.AsyncInsertMany.vectors",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType"
],
"value": "vectors: Iterable[VectorType | None] | None = vectors",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncInsertMany.vectorize
|
{
"kind": "attribute",
"name": "vectorize",
"path": "astrapy.operations.AsyncInsertMany.vectorize",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "vectorize: Iterable[str | None] | None = vectorize",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncInsertMany.ordered
|
{
"kind": "attribute",
"name": "ordered",
"path": "astrapy.operations.AsyncInsertMany.ordered",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "ordered: bool = ordered",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncInsertMany.chunk_size
|
{
"kind": "attribute",
"name": "chunk_size",
"path": "astrapy.operations.AsyncInsertMany.chunk_size",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "chunk_size: int | None = chunk_size",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncInsertMany.concurrency
|
{
"kind": "attribute",
"name": "concurrency",
"path": "astrapy.operations.AsyncInsertMany.concurrency",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "concurrency: int | None = concurrency",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncInsertMany.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.AsyncInsertMany.execute",
"parameters": [
{
"name": "collection",
"type": "AsyncCollection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult",
"astrapy.collection.AsyncCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.AsyncUpdateOne
|
Represents an `update_one` operation on a (async) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "AsyncUpdateOne",
"path": "astrapy.operations.AsyncUpdateOne",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "update",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "vector",
"type": "VectorType | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "vectorize",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "sort",
"type": "SortType | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "upsert",
"type": "bool",
"description": null,
"default": "False",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType",
"astrapy.constants.SortType",
"astrapy.operations.AsyncBaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.AsyncBaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "a filter condition to select a target document."
},
{
"name": "update",
"type": "dict[str, Any]",
"description": "an update prescription to apply to the document."
},
{
"name": "vector",
"type": "VectorType | None",
"description": "a vector of numbers to use for ANN (vector-search) sorting.\n*DEPRECATED* (removal in 2.0). Use a `$vector` key in the\nsort clause dict instead."
},
{
"name": "vectorize",
"type": "str | None",
"description": "a string to be made into a vector, with the same result as the\n`vector` attribute, through an embedding service, assuming one is\nconfigured for the collection.\n*DEPRECATED* (removal in 2.0). Use a `$vectorize` key in the\nsort clause dict instead."
},
{
"name": "sort",
"type": "SortType | None",
"description": "controls ordering of results, hence which document is affected."
},
{
"name": "upsert",
"type": "bool",
"description": "controls what to do when no documents are found."
}
]
}
|
astrapy.operations.AsyncUpdateOne.filter
|
{
"kind": "attribute",
"name": "filter",
"path": "astrapy.operations.AsyncUpdateOne.filter",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "filter: dict[str, Any] = filter",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncUpdateOne.update
|
{
"kind": "attribute",
"name": "update",
"path": "astrapy.operations.AsyncUpdateOne.update",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "update: dict[str, Any] = update",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncUpdateOne.vector
|
{
"kind": "attribute",
"name": "vector",
"path": "astrapy.operations.AsyncUpdateOne.vector",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType"
],
"value": "vector: VectorType | None = vector",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncUpdateOne.vectorize
|
{
"kind": "attribute",
"name": "vectorize",
"path": "astrapy.operations.AsyncUpdateOne.vectorize",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "vectorize: str | None = vectorize",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncUpdateOne.sort
|
{
"kind": "attribute",
"name": "sort",
"path": "astrapy.operations.AsyncUpdateOne.sort",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.SortType"
],
"value": "sort: SortType | None = sort",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncUpdateOne.upsert
|
{
"kind": "attribute",
"name": "upsert",
"path": "astrapy.operations.AsyncUpdateOne.upsert",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "upsert: bool = upsert",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncUpdateOne.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.AsyncUpdateOne.execute",
"parameters": [
{
"name": "collection",
"type": "AsyncCollection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult",
"astrapy.collection.AsyncCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.AsyncUpdateMany
|
Represents an `update_many` operation on a (async) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "AsyncUpdateMany",
"path": "astrapy.operations.AsyncUpdateMany",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "update",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "upsert",
"type": "bool",
"description": null,
"default": "False",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.operations.AsyncBaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.AsyncBaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "a filter condition to select target documents."
},
{
"name": "update",
"type": "dict[str, Any]",
"description": "an update prescription to apply to the documents."
},
{
"name": "upsert",
"type": "bool",
"description": "controls what to do when no documents are found."
}
]
}
|
astrapy.operations.AsyncUpdateMany.filter
|
{
"kind": "attribute",
"name": "filter",
"path": "astrapy.operations.AsyncUpdateMany.filter",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "filter: dict[str, Any] = filter",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncUpdateMany.update
|
{
"kind": "attribute",
"name": "update",
"path": "astrapy.operations.AsyncUpdateMany.update",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "update: dict[str, Any] = update",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncUpdateMany.upsert
|
{
"kind": "attribute",
"name": "upsert",
"path": "astrapy.operations.AsyncUpdateMany.upsert",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "upsert: bool = upsert",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncUpdateMany.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.AsyncUpdateMany.execute",
"parameters": [
{
"name": "collection",
"type": "AsyncCollection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult",
"astrapy.collection.AsyncCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.AsyncReplaceOne
|
Represents a `replace_one` operation on a (async) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "AsyncReplaceOne",
"path": "astrapy.operations.AsyncReplaceOne",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "replacement",
"type": "DocumentType",
"description": null,
"default": null,
"value": null
},
{
"name": "vector",
"type": "VectorType | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "vectorize",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "sort",
"type": "SortType | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "upsert",
"type": "bool",
"description": null,
"default": "False",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType",
"astrapy.constants.DocumentType",
"astrapy.constants.SortType",
"astrapy.operations.AsyncBaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.AsyncBaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "a filter condition to select a target document."
},
{
"name": "replacement",
"type": "DocumentType",
"description": "the replacement document."
},
{
"name": "vector",
"type": "VectorType | None",
"description": "a vector of numbers to use for ANN (vector-search) sorting.\n*DEPRECATED* (removal in 2.0). Use a `$vector` key in the\nsort clause dict instead."
},
{
"name": "vectorize",
"type": "str | None",
"description": "a string to be made into a vector, with the same result as the\n`vector` attribute, through an embedding service, assuming one is\nconfigured for the collection.\n*DEPRECATED* (removal in 2.0). Use a `$vectorize` key in the\nsort clause dict instead."
},
{
"name": "sort",
"type": "SortType | None",
"description": "controls ordering of results, hence which document is affected."
},
{
"name": "upsert",
"type": "bool",
"description": "controls what to do when no documents are found."
}
]
}
|
astrapy.operations.AsyncReplaceOne.filter
|
{
"kind": "attribute",
"name": "filter",
"path": "astrapy.operations.AsyncReplaceOne.filter",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "filter: dict[str, Any] = filter",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncReplaceOne.replacement
|
{
"kind": "attribute",
"name": "replacement",
"path": "astrapy.operations.AsyncReplaceOne.replacement",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.DocumentType"
],
"value": "replacement: DocumentType = replacement",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncReplaceOne.vector
|
{
"kind": "attribute",
"name": "vector",
"path": "astrapy.operations.AsyncReplaceOne.vector",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType"
],
"value": "vector: VectorType | None = vector",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncReplaceOne.vectorize
|
{
"kind": "attribute",
"name": "vectorize",
"path": "astrapy.operations.AsyncReplaceOne.vectorize",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "vectorize: str | None = vectorize",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncReplaceOne.sort
|
{
"kind": "attribute",
"name": "sort",
"path": "astrapy.operations.AsyncReplaceOne.sort",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.SortType"
],
"value": "sort: SortType | None = sort",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncReplaceOne.upsert
|
{
"kind": "attribute",
"name": "upsert",
"path": "astrapy.operations.AsyncReplaceOne.upsert",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "upsert: bool = upsert",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncReplaceOne.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.AsyncReplaceOne.execute",
"parameters": [
{
"name": "collection",
"type": "AsyncCollection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult",
"astrapy.collection.AsyncCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.AsyncDeleteOne
|
Represents a `delete_one` operation on a (async) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "AsyncDeleteOne",
"path": "astrapy.operations.AsyncDeleteOne",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
},
{
"name": "vector",
"type": "VectorType | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "vectorize",
"type": "str | None",
"description": null,
"default": "None",
"value": null
},
{
"name": "sort",
"type": "SortType | None",
"description": null,
"default": "None",
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType",
"astrapy.constants.SortType",
"astrapy.operations.AsyncBaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.AsyncBaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "a filter condition to select a target document."
},
{
"name": "vector",
"type": "VectorType | None",
"description": "a vector of numbers to use for ANN (vector-search) sorting.\n*DEPRECATED* (removal in 2.0). Use a `$vector` key in the\nsort clause dict instead."
},
{
"name": "vectorize",
"type": "str | None",
"description": "a string to be made into a vector, with the same result as the\n`vector` attribute, through an embedding service, assuming one is\nconfigured for the collection.\n*DEPRECATED* (removal in 2.0). Use a `$vectorize` key in the\nsort clause dict instead."
},
{
"name": "sort",
"type": "SortType | None",
"description": "controls ordering of results, hence which document is affected."
}
]
}
|
astrapy.operations.AsyncDeleteOne.filter
|
{
"kind": "attribute",
"name": "filter",
"path": "astrapy.operations.AsyncDeleteOne.filter",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "filter: dict[str, Any] = filter",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncDeleteOne.vector
|
{
"kind": "attribute",
"name": "vector",
"path": "astrapy.operations.AsyncDeleteOne.vector",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.VectorType"
],
"value": "vector: VectorType | None = vector",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncDeleteOne.vectorize
|
{
"kind": "attribute",
"name": "vectorize",
"path": "astrapy.operations.AsyncDeleteOne.vectorize",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "vectorize: str | None = vectorize",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncDeleteOne.sort
|
{
"kind": "attribute",
"name": "sort",
"path": "astrapy.operations.AsyncDeleteOne.sort",
"parameters": null,
"returns": null,
"gathered_types": [
"astrapy.constants.SortType"
],
"value": "sort: SortType | None = sort",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncDeleteOne.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.AsyncDeleteOne.execute",
"parameters": [
{
"name": "collection",
"type": "AsyncCollection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult",
"astrapy.collection.AsyncCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.operations.AsyncDeleteMany
|
Represents a `delete_many` operation on a (async) collection.
See the documentation on the collection method for more information.
|
{
"kind": "class",
"name": "AsyncDeleteMany",
"path": "astrapy.operations.AsyncDeleteMany",
"parameters": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": null,
"default": null,
"value": null
}
],
"returns": null,
"gathered_types": [
"astrapy.operations.AsyncBaseOperation"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": [
"astrapy.operations.AsyncBaseOperation"
],
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": [
{
"name": "filter",
"type": "dict[str, Any]",
"description": "a filter condition to select target documents."
}
]
}
|
astrapy.operations.AsyncDeleteMany.filter
|
{
"kind": "attribute",
"name": "filter",
"path": "astrapy.operations.AsyncDeleteMany.filter",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "filter: dict[str, Any] = filter",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.operations.AsyncDeleteMany.execute
|
Execute this operation against a collection as part of a bulk write.
|
{
"kind": "function",
"name": "execute",
"path": "astrapy.operations.AsyncDeleteMany.execute",
"parameters": [
{
"name": "collection",
"type": "AsyncCollection",
"description": "the collection this write targets.",
"default": null,
"value": null
},
{
"name": "insert_in_bulk_write",
"type": null,
"description": "the index in the list of bulkoperations",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "BulkWriteResult",
"description": null
}
],
"gathered_types": [
"astrapy.results.BulkWriteResult",
"astrapy.collection.AsyncCollection"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.admin
|
{
"kind": "module",
"name": "admin",
"path": "astrapy.admin",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": null,
"yields": null,
"imports": {
"annotations": "__future__.annotations",
"logging": "logging",
"Any": "typing.Any",
"cast": null,
"httpx": null,
"API_RESPONSE": null,
"amake_request": null,
"make_request": null,
"TypedDict": null,
"APIRequestError": null,
"api_request": null,
"async_api_request": null,
"async_raw_api_request": null,
"raw_api_request": null,
"OPS_API_RESPONSE": null,
"DEFAULT_DEV_OPS_API_VERSION": null,
"DEFAULT_DEV_OPS_AUTH_HEADER": "astrapy.defaults.DEFAULT_DEV_OPS_AUTH_HEADER",
"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__": "astrapy.__version__",
"DEFAULT_REDACTED_HEADERS": null,
"DEFAULT_TIMEOUT": null,
"UUID": null,
"ObjectId": null,
"uuid1": null,
"uuid3": null,
"uuid4": null,
"uuid5": null,
"uuid6": null,
"uuid7": null,
"uuid8": null,
"AstraDB": null,
"AstraDBCollection": null,
"AsyncAstraDB": null,
"AsyncAstraDBCollection": null,
"logger": null,
"AstraDBOps": null,
"asyncio": "asyncio",
"warnings": "warnings",
"ThreadPoolExecutor": null,
"TracebackType": null,
"TYPE_CHECKING": "typing.TYPE_CHECKING",
"Sequence": "typing.Sequence",
"deprecation": "deprecation",
"APICommander": "astrapy.api_commander.APICommander",
"CollectionAPIOptions": null,
"coerce_embedding_headers_provider": null,
"CallerType": "astrapy.constants.CallerType",
"DocumentType": null,
"FilterType": null,
"ProjectionType": null,
"ReturnDocument": null,
"SortType": null,
"VectorType": null,
"normalize_optional_projection": null,
"AsyncCursor": null,
"Cursor": null,
"AsyncDatabase": "astrapy.AsyncDatabase",
"Database": "astrapy.Database",
"DEFAULT_BULK_WRITE_CONCURRENCY": null,
"DEFAULT_DATA_API_AUTH_HEADER": "astrapy.defaults.DEFAULT_DATA_API_AUTH_HEADER",
"DEFAULT_INSERT_MANY_CHUNK_SIZE": null,
"DEFAULT_INSERT_MANY_CONCURRENCY": null,
"NAMESPACE_DEPRECATION_NOTICE_METHOD": "astrapy.defaults.NAMESPACE_DEPRECATION_NOTICE_METHOD",
"SET_CALLER_DEPRECATION_NOTICE": "astrapy.defaults.SET_CALLER_DEPRECATION_NOTICE",
"BulkWriteException": null,
"CollectionNotFoundException": null,
"CumulativeOperationException": null,
"DataAPIFaultyResponseException": "astrapy.exceptions.DataAPIFaultyResponseException",
"DataAPIResponseException": null,
"DeleteManyException": null,
"InsertManyException": null,
"MultiCallTimeoutManager": "astrapy.exceptions.MultiCallTimeoutManager",
"TooManyDocumentsToCountException": null,
"UpdateManyException": null,
"base_timeout_info": "astrapy.exceptions.base_timeout_info",
"CollectionInfo": null,
"CollectionOptions": null,
"check_caller_parameters": "astrapy.meta.check_caller_parameters",
"check_deprecated_vector_ize": null,
"check_namespace_keyspace": "astrapy.meta.check_namespace_keyspace",
"BulkWriteResult": null,
"DeleteResult": null,
"InsertManyResult": null,
"InsertOneResult": null,
"UpdateResult": null,
"EmbeddingHeadersProvider": null,
"AsyncBaseOperation": null,
"BaseOperation": null,
"dataclass": "dataclasses.dataclass",
"TimeoutInfo": null,
"OperationResult": null,
"DEFAULT_REDACTED_HEADER_NAMES": null,
"DEFAULT_REQUEST_TIMEOUT_MS": null,
"HEADER_REDACT_PLACEHOLDER": null,
"DataAPIHttpException": null,
"DevOpsAPIFaultyResponseException": null,
"DevOpsAPIHttpException": null,
"DevOpsAPIResponseException": null,
"to_dataapi_timeout_exception": null,
"to_devopsapi_timeout_exception": null,
"HttpMethod": "astrapy.request_tools.HttpMethod",
"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": "abc.ABC",
"abstractmethod": "abc.abstractmethod",
"fetch_database_info": null,
"parse_api_endpoint": null,
"coerce_token_provider": "astrapy.authentication.coerce_token_provider",
"redact_secret": "astrapy.authentication.redact_secret",
"Environment": "astrapy.constants.Environment",
"AsyncCommandCursor": null,
"CommandCursor": "astrapy.cursors.CommandCursor",
"API_PATH_ENV_MAP": "astrapy.defaults.API_PATH_ENV_MAP",
"API_VERSION_ENV_MAP": "astrapy.defaults.API_VERSION_ENV_MAP",
"DEFAULT_ASTRA_DB_KEYSPACE": null,
"CollectionAlreadyExistsException": null,
"DevOpsAPIException": "astrapy.exceptions.DevOpsAPIException",
"CollectionDescriptor": null,
"CollectionVectorServiceOptions": null,
"DatabaseInfo": "astrapy.info.DatabaseInfo",
"DatabaseAdmin": null,
"TokenProvider": "astrapy.authentication.TokenProvider",
"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": "re",
"API_ENDPOINT_TEMPLATE_ENV_MAP": "astrapy.defaults.API_ENDPOINT_TEMPLATE_ENV_MAP",
"DEFAULT_DEV_OPS_AUTH_PREFIX": "astrapy.defaults.DEFAULT_DEV_OPS_AUTH_PREFIX",
"DEV_OPS_DATABASE_POLL_INTERVAL_S": "astrapy.defaults.DEV_OPS_DATABASE_POLL_INTERVAL_S",
"DEV_OPS_DATABASE_STATUS_ACTIVE": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_ACTIVE",
"DEV_OPS_DATABASE_STATUS_INITIALIZING": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_INITIALIZING",
"DEV_OPS_DATABASE_STATUS_MAINTENANCE": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_MAINTENANCE",
"DEV_OPS_DATABASE_STATUS_PENDING": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_PENDING",
"DEV_OPS_DATABASE_STATUS_TERMINATING": "astrapy.defaults.DEV_OPS_DATABASE_STATUS_TERMINATING",
"DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE": "astrapy.defaults.DEV_OPS_DEFAULT_DATABASES_PAGE_SIZE",
"DEV_OPS_KEYSPACE_POLL_INTERVAL_S": "astrapy.defaults.DEV_OPS_KEYSPACE_POLL_INTERVAL_S",
"DEV_OPS_RESPONSE_HTTP_ACCEPTED": "astrapy.defaults.DEV_OPS_RESPONSE_HTTP_ACCEPTED",
"DEV_OPS_RESPONSE_HTTP_CREATED": "astrapy.defaults.DEV_OPS_RESPONSE_HTTP_CREATED",
"DEV_OPS_URL_ENV_MAP": "astrapy.defaults.DEV_OPS_URL_ENV_MAP",
"DEV_OPS_VERSION_ENV_MAP": "astrapy.defaults.DEV_OPS_VERSION_ENV_MAP",
"AdminDatabaseInfo": "astrapy.info.AdminDatabaseInfo",
"FindEmbeddingProvidersResult": "astrapy.info.FindEmbeddingProvidersResult",
"check_update_db_namespace_keyspace": "astrapy.meta.check_update_db_namespace_keyspace",
"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.admin.logger
|
{
"kind": "attribute",
"name": "logger",
"path": "astrapy.admin.logger",
"parameters": null,
"returns": null,
"gathered_types": [
"__name__"
],
"value": "logger = logging.getLogger(__name__)",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.admin.database_id_matcher
|
{
"kind": "attribute",
"name": "database_id_matcher",
"path": "astrapy.admin.database_id_matcher",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "database_id_matcher = re.compile('^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.admin.api_endpoint_parser
|
{
"kind": "attribute",
"name": "api_endpoint_parser",
"path": "astrapy.admin.api_endpoint_parser",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "api_endpoint_parser = re.compile('https://([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})-([a-z0-9\\\\-]+).apps.astra[\\\\-]{0,1}(dev|test)?.datastax.com')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.admin.api_endpoint_description
|
{
"kind": "attribute",
"name": "api_endpoint_description",
"path": "astrapy.admin.api_endpoint_description",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "api_endpoint_description = 'https://<db uuid, 8-4-4-4-12 hex format>-<db region>.apps.astra.datastax.com'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.admin.generic_api_url_matcher
|
{
"kind": "attribute",
"name": "generic_api_url_matcher",
"path": "astrapy.admin.generic_api_url_matcher",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "generic_api_url_matcher = re.compile('^https?:\\\\/\\\\/[a-zA-Z0-9\\\\-.]+(\\\\:[0-9]{1,6}){0,1}$')",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.admin.generic_api_url_descriptor
|
{
"kind": "attribute",
"name": "generic_api_url_descriptor",
"path": "astrapy.admin.generic_api_url_descriptor",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "generic_api_url_descriptor = 'http[s]://<domain name or IP>[:port]'",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.admin.ParsedAPIEndpoint
|
The results of successfully parsing an Astra DB API endpoint, for internal
by database metadata-related functions.
|
{
"kind": "class",
"name": "ParsedAPIEndpoint",
"path": "astrapy.admin.ParsedAPIEndpoint",
"parameters": [
{
"name": "database_id",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "region",
"type": "str",
"description": null,
"default": null,
"value": null
},
{
"name": "environment",
"type": "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": "database_id",
"type": "str",
"description": "e. g. \"01234567-89ab-cdef-0123-456789abcdef\"."
},
{
"name": "region",
"type": "str",
"description": "a region ID, such as \"us-west1\"."
},
{
"name": "environment",
"type": "str",
"description": "a label, whose value is one of Environment.PROD,\nEnvironment.DEV or Environment.TEST."
}
]
}
|
astrapy.admin.ParsedAPIEndpoint.database_id
|
{
"kind": "attribute",
"name": "database_id",
"path": "astrapy.admin.ParsedAPIEndpoint.database_id",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "database_id: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.admin.ParsedAPIEndpoint.region
|
{
"kind": "attribute",
"name": "region",
"path": "astrapy.admin.ParsedAPIEndpoint.region",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "region: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.admin.ParsedAPIEndpoint.environment
|
{
"kind": "attribute",
"name": "environment",
"path": "astrapy.admin.ParsedAPIEndpoint.environment",
"parameters": null,
"returns": null,
"gathered_types": null,
"value": "environment: str",
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
|
astrapy.admin.parse_api_endpoint
|
Parse an API Endpoint into a ParsedAPIEndpoint structure.
|
{
"kind": "function",
"name": "parse_api_endpoint",
"path": "astrapy.admin.parse_api_endpoint",
"parameters": [
{
"name": "api_endpoint",
"type": "str",
"description": "a full API endpoint for the Data API.",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "ParsedAPIEndpoint | None",
"description": "The parsed ParsedAPIEndpoint. If parsing fails, return None."
}
],
"gathered_types": [
"ParsedAPIEndpoint"
],
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.admin.api_endpoint_parsing_error_message
|
Format an error message with a suggestion for the expected url format.
|
{
"kind": "function",
"name": "api_endpoint_parsing_error_message",
"path": "astrapy.admin.api_endpoint_parsing_error_message",
"parameters": [
{
"name": "failing_url",
"type": "str",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "str",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.admin.parse_generic_api_url
|
Validate a generic API Endpoint string,
such as `http://10.1.1.1:123` or `https://my.domain`.
|
{
"kind": "function",
"name": "parse_generic_api_url",
"path": "astrapy.admin.parse_generic_api_url",
"parameters": [
{
"name": "api_endpoint",
"type": "str",
"description": "a string supposedly expressing a valid API Endpoint",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "str | None",
"description": "a normalized (stripped) version of the endpoint if valid. If invalid,"
},
{
"name": null,
"type": "str | None",
"description": "return None."
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.admin.generic_api_url_parsing_error_message
|
Format an error message with a suggestion for the expected url format.
|
{
"kind": "function",
"name": "generic_api_url_parsing_error_message",
"path": "astrapy.admin.generic_api_url_parsing_error_message",
"parameters": [
{
"name": "failing_url",
"type": "str",
"description": null,
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "str",
"description": null
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
astrapy.admin.build_api_endpoint
|
Build the API Endpoint full strings from database parameters.
|
{
"kind": "function",
"name": "build_api_endpoint",
"path": "astrapy.admin.build_api_endpoint",
"parameters": [
{
"name": "environment",
"type": "str",
"description": "a label, whose value can be Environment.PROD\nor another of Environment.* for which this operation makes sense.",
"default": null,
"value": null
},
{
"name": "database_id",
"type": "str",
"description": "e. g. \"01234567-89ab-cdef-0123-456789abcdef\".",
"default": null,
"value": null
},
{
"name": "region",
"type": "str",
"description": "a region ID, such as \"us-west1\".",
"default": null,
"value": null
}
],
"returns": [
{
"name": null,
"type": "str",
"description": "the endpoint string, such as \"https://01234567-...-eu-west1.apps.datastax.com\""
}
],
"gathered_types": null,
"value": null,
"yields": null,
"imports": null,
"properties": null,
"bases": null,
"exports": null,
"example": null,
"references": null,
"note": null,
"implemented_by": null,
"attributes": null
}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.