# Firestore Loader
This loader loads from a Firestore collection or a specific document from Firestore. The loader assumes your project already has the google cloud credentials loaded. To find out how to set up credentials, [see here](https://cloud.google.com/docs/authentication/provide-credentials-adc).
## Usage
To initialize the loader, provide the project-id of the google cloud project.
## Initializing the reader
```python
from llama_index import download_loader
FirestoreReader = download_loader("FirestoreReader")
reader = FirestoreReader(project_id="<Your Project ID>")
```
## Loading Data from a Firestore Collection
Load data from a Firestore collection with the load_data method:
The collection path should include all previous documents and collections if it is a nested collection.
```python
documents = reader.load_data(collection="foo/bar/abc/")
```
## Loading a Single Document from Firestore
Load a single document from Firestore with the load_document method:
```python
document = reader.load_document(document_url="foo/bar/abc/MY_DOCUMENT")
```
Note: load_data returns a list of Document objects, whereas load_document returns a single Document object.
This loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent. See [here](https://github.com/emptycrown/llama-hub/tree/main) for examples.
Raw data
{
"_id": null,
"home_page": "",
"name": "llama-index-readers-firestore",
"maintainer": "rayzhudev",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0",
"maintainer_email": "",
"keywords": "datastore,firestore",
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/a9/ac/59aeb95ad11d6ee79b54a5d4d4ff69021a847be402018c02ea1308f52c52/llama_index_readers_firestore-0.1.3.tar.gz",
"platform": null,
"description": "# Firestore Loader\n\nThis loader loads from a Firestore collection or a specific document from Firestore. The loader assumes your project already has the google cloud credentials loaded. To find out how to set up credentials, [see here](https://cloud.google.com/docs/authentication/provide-credentials-adc).\n\n## Usage\n\nTo initialize the loader, provide the project-id of the google cloud project.\n\n## Initializing the reader\n\n```python\nfrom llama_index import download_loader\n\nFirestoreReader = download_loader(\"FirestoreReader\")\nreader = FirestoreReader(project_id=\"<Your Project ID>\")\n```\n\n## Loading Data from a Firestore Collection\n\nLoad data from a Firestore collection with the load_data method:\nThe collection path should include all previous documents and collections if it is a nested collection.\n\n```python\ndocuments = reader.load_data(collection=\"foo/bar/abc/\")\n```\n\n## Loading a Single Document from Firestore\n\nLoad a single document from Firestore with the load_document method:\n\n```python\ndocument = reader.load_document(document_url=\"foo/bar/abc/MY_DOCUMENT\")\n```\n\nNote: load_data returns a list of Document objects, whereas load_document returns a single Document object.\n\nThis loader is designed to be used as a way to load data into [LlamaIndex](https://github.com/run-llama/llama_index/tree/main/llama_index) and/or subsequently used as a Tool in a [LangChain](https://github.com/hwchase17/langchain) Agent. See [here](https://github.com/emptycrown/llama-hub/tree/main) for examples.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers firestore integration",
"version": "0.1.3",
"project_urls": null,
"split_keywords": [
"datastore",
"firestore"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aa61a7b3bdd27d10aba93617ad69e25eb2b508f9aa44ee6e9d49313550585eea",
"md5": "b9e3935335b6db06c502197da5ab3a22",
"sha256": "c96fc2c4f65265c8f62a2060911864cf3c508045650b531714bcb1c07e9ad808"
},
"downloads": -1,
"filename": "llama_index_readers_firestore-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b9e3935335b6db06c502197da5ab3a22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0",
"size": 3286,
"upload_time": "2024-02-21T19:53:28",
"upload_time_iso_8601": "2024-02-21T19:53:28.814078Z",
"url": "https://files.pythonhosted.org/packages/aa/61/a7b3bdd27d10aba93617ad69e25eb2b508f9aa44ee6e9d49313550585eea/llama_index_readers_firestore-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a9ac59aeb95ad11d6ee79b54a5d4d4ff69021a847be402018c02ea1308f52c52",
"md5": "fe444bcf48b7eba350feb4e786852d23",
"sha256": "8062be387bc9b1d2bf09626954b8125eeaab996b5b19b5532d3df972ebec6ee7"
},
"downloads": -1,
"filename": "llama_index_readers_firestore-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "fe444bcf48b7eba350feb4e786852d23",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0",
"size": 3011,
"upload_time": "2024-02-21T19:53:29",
"upload_time_iso_8601": "2024-02-21T19:53:29.973315Z",
"url": "https://files.pythonhosted.org/packages/a9/ac/59aeb95ad11d6ee79b54a5d4d4ff69021a847be402018c02ea1308f52c52/llama_index_readers_firestore-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-21 19:53:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-firestore"
}
JSON