http4s-grpc-google-cloud-firestore-v1
3.21.3+0.0.6
API
Generated with
http4s-grpc-google-cloud-firestore-v1/com.google.firestore/com.google.firestore.v1/com.google.firestore.v1.firestore/Firestore

Firestore

com.google.firestore.v1.firestore.Firestore
See theFirestore companion object
trait Firestore[F[_]]

The Cloud Firestore service.

Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global scale. Its client libraries provide live synchronization and offline support, while its security features and integrations with Firebase and Google Cloud Platform accelerate building truly serverless apps.

Attributes

Companion
object
Source
Firestore.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def batchGetDocuments(request: BatchGetDocumentsRequest, ctx: Headers): Stream[F, BatchGetDocumentsResponse]

Gets multiple documents.

Gets multiple documents.

Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

Attributes

Source
Firestore.scala
def batchWrite(request: BatchWriteRequest, ctx: Headers): F[BatchWriteResponse]

Applies a batch of write operations.

Applies a batch of write operations.

The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the success status of each write.

If you require an atomically applied set of writes, use [Commit][google.firestore.v1.Firestore.Commit] instead.

Attributes

Source
Firestore.scala
def beginTransaction(request: BeginTransactionRequest, ctx: Headers): F[BeginTransactionResponse]

Starts a new transaction.

Starts a new transaction.

Attributes

Source
Firestore.scala
def commit(request: CommitRequest, ctx: Headers): F[CommitResponse]

Commits a transaction, while optionally updating documents.

Commits a transaction, while optionally updating documents.

Attributes

Source
Firestore.scala
def createDocument(request: CreateDocumentRequest, ctx: Headers): F[Document]

Creates a new document.

Creates a new document.

Attributes

Source
Firestore.scala
def deleteDocument(request: DeleteDocumentRequest, ctx: Headers): F[Empty]

Deletes a document.

Deletes a document.

Attributes

Source
Firestore.scala
def getDocument(request: GetDocumentRequest, ctx: Headers): F[Document]

Gets a single document.

Gets a single document.

Attributes

Source
Firestore.scala
def listCollectionIds(request: ListCollectionIdsRequest, ctx: Headers): F[ListCollectionIdsResponse]

Lists all the collection IDs underneath a document.

Lists all the collection IDs underneath a document.

Attributes

Source
Firestore.scala
def listDocuments(request: ListDocumentsRequest, ctx: Headers): F[ListDocumentsResponse]

Lists documents.

Lists documents.

Attributes

Source
Firestore.scala
def listen(request: Stream[F, ListenRequest], ctx: Headers): Stream[F, ListenResponse]

Listens to changes.

Listens to changes. This method is only available via gRPC or WebChannel (not REST).

Attributes

Source
Firestore.scala
def partitionQuery(request: PartitionQueryRequest, ctx: Headers): F[PartitionQueryResponse]

Partitions a query by returning partition cursors that can be used to run the query in parallel.

Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.

Attributes

Source
Firestore.scala
def rollback(request: RollbackRequest, ctx: Headers): F[Empty]

Rolls back a transaction.

Rolls back a transaction.

Attributes

Source
Firestore.scala
def runAggregationQuery(request: RunAggregationQueryRequest, ctx: Headers): Stream[F, RunAggregationQueryResponse]

Runs an aggregation query.

Runs an aggregation query.

Rather than producing [Document][google.firestore.v1.Document] results like [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery], this API allows running an aggregation to produce a series of [AggregationResult][google.firestore.v1.AggregationResult] server-side.

High-Level Example:

-- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true );

Attributes

Source
Firestore.scala
def runQuery(request: RunQueryRequest, ctx: Headers): Stream[F, RunQueryResponse]

Runs a query.

Runs a query.

Attributes

Source
Firestore.scala
def updateDocument(request: UpdateDocumentRequest, ctx: Headers): F[Document]

Updates or inserts a document.

Updates or inserts a document.

Attributes

Source
Firestore.scala
def write(request: Stream[F, WriteRequest], ctx: Headers): Stream[F, WriteResponse]

Streams batches of document updates and deletes, in order.

Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).

Attributes

Source
Firestore.scala
Generated with