mirror of
https://github.com/titanscouting/tra-analysis.git
synced 2024-11-14 07:06:17 +00:00
142 lines
5.2 KiB
Markdown
142 lines
5.2 KiB
Markdown
|
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
|
|||
|
|
|
|||
|
|
# [Google Cloud Firestore: Node.js Server SDK](https://github.com/googleapis/nodejs-firestore)
|
|||
|
|
|
|||
|
|
[](https://cloud.google.com/terms/launch-stages)
|
|||
|
|
[](https://circleci.com/gh/googleapis/nodejs-firestore)
|
|||
|
|
[](https://ci.appveyor.com/project/googleapis/nodejs-firestore)
|
|||
|
|
[](https://codecov.io/gh/googleapis/nodejs-firestore)
|
|||
|
|
|
|||
|
|
This is the Node.js Server SDK for
|
|||
|
|
[Google Cloud Firestore](https://firebase.google.com/docs/firestore/). Google
|
|||
|
|
Cloud Firestore is a NoSQL document database built for automatic scaling, high
|
|||
|
|
performance, and ease of application development.
|
|||
|
|
|
|||
|
|
This Cloud Firestore Server SDK uses Google’s [Cloud Identity and Access
|
|||
|
|
Management](https://cloud.google.com/firestore/docs/security/iam) for
|
|||
|
|
authentication and should only be used **in trusted environments**. Your Cloud
|
|||
|
|
Identity credentials allow you bypass all access restrictions and provide read
|
|||
|
|
and write access to all data in your Cloud Firestore project.
|
|||
|
|
|
|||
|
|
The Cloud Firestore Server SDKs are designed to manage the full set of data in
|
|||
|
|
your Cloud Firestore project and work best with reliable network connectivity.
|
|||
|
|
Data operations performed via these SDKs directly access the Cloud Firestore
|
|||
|
|
backend and all document reads and writes are optimized for high throughput.
|
|||
|
|
|
|||
|
|
Applications that use Google's Server SDKs should not be used in end-user
|
|||
|
|
environments, such as on phones or on publicly hosted websites. If you are
|
|||
|
|
developing a Web or Node.js application that accesses Cloud Firestore on behalf
|
|||
|
|
of end users, use the [`firebase`](https://www.npmjs.com/package/firebase)
|
|||
|
|
Client SDK.
|
|||
|
|
|
|||
|
|
**Table of contents:**
|
|||
|
|
|
|||
|
|
* [Quickstart](#quickstart)
|
|||
|
|
* [Before you begin](#before-you-begin)
|
|||
|
|
* [Installing the client library](#installing-the-client-library)
|
|||
|
|
* [Using the client library](#using-the-client-library)
|
|||
|
|
* [Versioning](#versioning)
|
|||
|
|
* [Contributing](#contributing)
|
|||
|
|
* [License](#license)
|
|||
|
|
|
|||
|
|
## Quickstart
|
|||
|
|
|
|||
|
|
Read more about the client libraries for Cloud APIs, including the older
|
|||
|
|
Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
|||
|
|
|
|||
|
|
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
|
|||
|
|
|
|||
|
|
* [Cloud Firestore Node.js Client API Reference][client-docs]
|
|||
|
|
* [github.com/googleapis/nodejs-firestore](https://github.com/googleapis/nodejs-firestore)
|
|||
|
|
* [Cloud Firestore Documentation][product-docs]
|
|||
|
|
|
|||
|
|
### Before you begin
|
|||
|
|
|
|||
|
|
1. Select or create a Cloud Platform project.
|
|||
|
|
|
|||
|
|
[Go to the projects page][projects]
|
|||
|
|
|
|||
|
|
1. Enable the Google Cloud Firestore API.
|
|||
|
|
|
|||
|
|
[Enable the API][enable_api]
|
|||
|
|
|
|||
|
|
1. [Set up authentication with a service account][auth] so you can access the
|
|||
|
|
API from your local workstation.
|
|||
|
|
|
|||
|
|
[projects]: https://console.cloud.google.com/project
|
|||
|
|
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=firestore.googleapis.com
|
|||
|
|
[auth]: https://cloud.google.com/docs/authentication/getting-started
|
|||
|
|
|
|||
|
|
### Installing the client library
|
|||
|
|
|
|||
|
|
npm install --save @google-cloud/firestore
|
|||
|
|
|
|||
|
|
### Using the client library
|
|||
|
|
|
|||
|
|
```javascript
|
|||
|
|
const Firestore = require('@google-cloud/firestore');
|
|||
|
|
|
|||
|
|
const firestore = new Firestore({
|
|||
|
|
projectId: 'YOUR_PROJECT_ID',
|
|||
|
|
keyFilename: '/path/to/keyfile.json',
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
const document = firestore.doc('posts/intro-to-firestore');
|
|||
|
|
|
|||
|
|
// Enter new data into the document.
|
|||
|
|
document.set({
|
|||
|
|
title: 'Welcome to Firestore',
|
|||
|
|
body: 'Hello World',
|
|||
|
|
}).then(() => {
|
|||
|
|
// Document created successfully.
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
// Update an existing document.
|
|||
|
|
document.update({
|
|||
|
|
body: 'My first Firestore app',
|
|||
|
|
}).then(() => {
|
|||
|
|
// Document updated successfully.
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
// Read the document.
|
|||
|
|
document.get().then(doc => {
|
|||
|
|
// Document read successfully.
|
|||
|
|
});
|
|||
|
|
|
|||
|
|
// Delete the document.
|
|||
|
|
document.delete().then(() => {
|
|||
|
|
// Document deleted successfully.
|
|||
|
|
});
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
|
|||
|
|
The [Cloud Firestore Node.js Client API Reference][client-docs] documentation
|
|||
|
|
also contains samples.
|
|||
|
|
|
|||
|
|
## Versioning
|
|||
|
|
|
|||
|
|
This library follows [Semantic Versioning](http://semver.org/).
|
|||
|
|
|
|||
|
|
This library is considered to be in **beta**. This means it is expected to be
|
|||
|
|
mostly stable while we work toward a general availability release; however,
|
|||
|
|
complete stability is not guaranteed. We will address issues and requests
|
|||
|
|
against beta libraries with a high priority.
|
|||
|
|
|
|||
|
|
More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
|||
|
|
|
|||
|
|
[launch_stages]: https://cloud.google.com/terms/launch-stages
|
|||
|
|
|
|||
|
|
## Contributing
|
|||
|
|
|
|||
|
|
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-firestore/blob/master/.github/CONTRIBUTING.md).
|
|||
|
|
|
|||
|
|
## License
|
|||
|
|
|
|||
|
|
Apache Version 2.0
|
|||
|
|
|
|||
|
|
See [LICENSE](https://github.com/googleapis/nodejs-firestore/blob/master/LICENSE)
|
|||
|
|
|
|||
|
|
[client-docs]: https://cloud.google.com/nodejs/docs/reference/firestore/latest/
|
|||
|
|
[product-docs]: https://firebase.google.com/docs/firestore/
|
|||
|
|
[shell_img]: //gstatic.com/cloudssh/images/open-btn.png
|