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_... |
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[VectorTyp... |
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": n... | |
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":... | |
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"... | |
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,
"r... | |
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,
"ex... | |
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,
... | |
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... |
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]",
"descript... |
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,... | |
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,... | |
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... | |
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... | |
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... | |
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,
"refere... | |
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_... |
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]",
"descri... |
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... | |
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... | |
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,
"refer... | |
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... |
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",
"des... |
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... | |
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": nul... | |
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": nul... | |
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,
"exampl... | |
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,
"export... | |
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,
"refer... | |
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... |
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",
"descr... |
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,... | |
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... | |
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... | |
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... | |
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_... |
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.BaseOp... |
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... | |
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... |
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": nu... |
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... | |
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",
... |
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,
"ba... | |
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":... | |
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,
"ex... | |
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": "inser... |
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... |
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,
"propertie... | |
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,
"propert... | |
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,
"exp... | |
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,... | |
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,
... | |
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": nu... | |
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": "inse... |
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]",
... |
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": ... | |
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": ... | |
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":... | |
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,
"ex... | |
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,
"ex... | |
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,
"r... | |
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": "inser... |
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]",
... |
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":... | |
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":... | |
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,
"... | |
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": "inse... |
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",
... |
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":... | |
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"... | |
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"... | |
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,
"e... | |
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,
"e... | |
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,
"... | |
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": "inse... |
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",
... |
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": ... | |
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":... | |
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,
"ex... | |
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,
"ex... | |
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": "inser... |
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.operati... |
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":... | |
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": "inse... |
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,
... | |
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":... | |
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,
... | |
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\\\\-]+)... | |
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,
... | |
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,
"impor... | |
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":... | |
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": ... |
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,
... | |
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": ... | |
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,
... | |
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": [
{
... |
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": [
{
"nam... |
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
}
],
"retu... |
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": [
{
... |
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.",
"d... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.