Skip to content

Firestore

FirestoreIndexStore #

Bases: KVIndexStore

Firestore索引存储。

Parameters:

Name Type Description Default
firestore_kvstore FirestoreKVStore

Firestore键值存储

required
namespace str

索引存储的命名空间

None
Source code in llama_index/storage/index_store/firestore/base.py
 7
 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
class FirestoreIndexStore(KVIndexStore):
    """Firestore索引存储。

    Args:
        firestore_kvstore (FirestoreKVStore): Firestore键值存储
        namespace (str): 索引存储的命名空间"""

    def __init__(
        self,
        firestore_kvstore: FirestoreKVStore,
        namespace: Optional[str] = None,
    ) -> None:
        """初始化一个FirestoreIndexStore。"""
        super().__init__(firestore_kvstore, namespace=namespace)

    @classmethod
    def from_database(
        cls,
        project: str,
        database: str,
        namespace: Optional[str] = None,
    ) -> "FirestoreIndexStore":
        """Args:
    project(str):客户端代表的项目。
    database(str):客户端目标的数据库名称。
    namespace(str):文档存储的命名空间。
"""
        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,
) -> FirestoreIndexStore

Args: project(str):客户端代表的项目。 database(str):客户端目标的数据库名称。 namespace(str):文档存储的命名空间。

Source code in llama_index/storage/index_store/firestore/base.py
22
23
24
25
26
27
28
29
30
31
32
33
34
35
    @classmethod
    def from_database(
        cls,
        project: str,
        database: str,
        namespace: Optional[str] = None,
    ) -> "FirestoreIndexStore":
        """Args:
    project(str):客户端代表的项目。
    database(str):客户端目标的数据库名称。
    namespace(str):文档存储的命名空间。
"""
        firestore_kvstore = FirestoreKVStore(project=project, database=database)
        return cls(firestore_kvstore, namespace)