跳至内容

Firestore

Firestore文档存储 #

基类: KVDocumentStore

Firestore 文档（节点）存储。

用于存储文档和节点对象的Firestore存储。

参数:

名称 类型 描述 默认值
firestore_kvstore FirestoreKVStore

Firestore 键值存储

 required
namespace str

文档存储的命名空间

 None
Source code in llama-index-integrations/storage/docstore/llama-index-storage-docstore-firestore/llama_index/storage/docstore/firestore/base.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class FirestoreDocumentStore(KVDocumentStore):
    """
    Firestore Document (Node) store.

    A Firestore store for Document and Node objects.

    Args:
        firestore_kvstore (FirestoreKVStore): Firestore key-value store
        namespace (str): namespace for the docstore

    """

    def __init__(
        self,
        firestore_kvstore: FirestoreKVStore,
        namespace: Optional[str] = None,
        batch_size: int = DEFAULT_BATCH_SIZE,
    ) -> None:
        """Init a FirestoreDocumentStore."""
        super().__init__(firestore_kvstore, namespace=namespace, batch_size=batch_size)

    @classmethod
    def from_database(
        cls,
        project: str,
        database: str,
        namespace: Optional[str] = None,
    ) -> "FirestoreDocumentStore":
        """
        Args:
            project (str): The project which the client acts on behalf of.
            database (str): The database name that the client targets.
            namespace (str): namespace for the docstore.

        """
        firestore_kvstore = FirestoreKVStore(project=project, database=database)
        return cls(firestore_kvstore, namespace)

from_database classmethod #

from_database(project: str, database: str, namespace: Optional[str] = None) -> FirestoreDocumentStore

参数:

名称 类型 描述 默认值
project str

客户所代表的项目。

 required
database str

客户端所指向的数据库名称。

 required
namespace str

文档存储的命名空间。

 None
Source code in llama-index-integrations/storage/docstore/llama-index-storage-docstore-firestore/llama_index/storage/docstore/firestore/base.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@classmethod
def from_database(
    cls,
    project: str,
    database: str,
    namespace: Optional[str] = None,
) -> "FirestoreDocumentStore":
    """
    Args:
        project (str): The project which the client acts on behalf of.
        database (str): The database name that the client targets.
        namespace (str): namespace for the docstore.

    """
    firestore_kvstore = FirestoreKVStore(project=project, database=database)
    return cls(firestore_kvstore, namespace)