firestore-clj.core — lurodrigo/firestore-clj 1.2.1

->atom clj

(->atom q)

(->atom q
        {:keys [error-handler plain-fn]
         :or {error-handler identity plain-fn snap->plain}})

Returns an atom holding the latest value of a DocumentReference or Query.

->stream clj

(->stream q)

(->stream q
          {:keys [error-handler plain-fn]
           :or {error-handler identity plain-fn snap->plain}})

Returns a manifold stream pushing the latest values of a DocumentReference or Query.

add! clj

(add! cr m)

Adds a document to a collection. Its id will be automatically generated.

add-listener clj

(add-listener q f)

Adds a snapshot listener to a DocumentReference or Query.

Listener is a fn of arity 2. First arg is the QuerySnapshot, second arg is a FirestoreException. Returns an ListenerRegistration object.

array-remove clj

(array-remove & vs)

Used with set! and merge!. Removes values from an array field.

array-union clj

(array-union & vs)

Used with set! and merge!. Adds unique values to an array field.

assoc clj

(assoc context dr & fvs)

Associates new fields and values in a batched write/transaction context.

assoc! clj

(assoc! dr & fvs)

Associates new fields and values.

batch clj

(batch db)

Get a new write batch

batch-delete! clj

(batch-delete! doc-seq batch-size)

Deletes all documents in a seq of DocumentReference.

changes clj

(changes s)

Returns a vector of changes. Each change is a map with keys :type, :ref, :new-index, and :old-index. Type is one of #{:added :removed :modified}.

client-with-creds clj

(client-with-creds creds-path)

Creates a client from a credentials JSON file.

coll clj

(coll r coll-name)

Returns a CollectionReference for the collection of given name.

coll-group clj

(coll-group db coll-id)

Returns a query that includes all documents contained in a collection or subcollection with the given id.

colls clj

(colls d)

(colls d cs)

Returns collections or subcollections as a vector of CollectionReference.

commit! clj

(commit! b)

Commits a write batch.

count clj

(count qs)

Number of documents in a QuerySnapshot

create! clj

(create! dr m)

Creates a new document at the DocumentReference's location. Fails if the document exists.

create-time clj

(create-time ds)

The time at which this document was created.

default-client clj

(default-client project-id)

Gets default client i.e. using a service account.

delete clj

(delete context dr)

Deletes a document in a batched write/transaction context.

delete! clj

(delete! dr)

Deletes a document.

delete-all! clj

(delete-all! q)

(delete-all! q batch-size)

Deletes all documents from a query. Batches for efficiency. Query must not contain limit or offset.

delete-all!* clj

(delete-all!* q)

(delete-all!* q batch-size)

Deletes all documents resulting from a query. Batches for efficiency. Fetches all results in memory.

detach clj

(detach a)

Detaches an atom built with ->atom or a listener returned from add-listener.

dissoc clj

(dissoc context dr & ks)

Deletes keys in a batched write/transaction context.

dissoc! clj

(dissoc! dr & fields)

Deletes fields.

doc clj

(doc cr)

(doc cr id)

Gets a DocumentReference given CollectionReference or Firestore and a path. If path is not given, it will point to a new document with an auto-generated-id

doc-snap clj

(doc-snap dr)

(doc-snap dr t)

Gets a QueryDocumentSnapshot given a DocumentReference and possibly a Transaction.

docs clj

(docs c)

(docs c ds)

Gets a vector of DocumentReferences.

ds->plain clj

(ds->plain s)

Represents a DocumentSnapshot as plain map.

ds->plain-with-id clj

(ds->plain-with-id s)

Represents a DocumentSnapshot as a [id plain-doc] pair

emulator-client clj

(emulator-client project-id emulator-host)

Gets a client using the emulator.

end-at clj

(end-at q & args)

Ends results at the provided document, or at the provided fields relative to the order of the query.

end-before clj

(end-before q & args)

Ends results before the provided document, or at the provided fields relative to the order of the query.

exists? clj

(exists? ds)

Checks whether the document snapshot exists.

filter-contains clj

(filter-contains q field value)

Filters where field contains value.

filter-contains-any clj

(filter-contains-any q field arr)

Filters where field contains one of the values in arr.

filter-in clj

(filter-in q field arr)

Filters where field is one of the values in arr.

filter< clj

(filter< q field value)

Filters where field < value.

filter<= clj

(filter<= q field value)

Filters where field <= value.

filter= clj

(filter= q m)

(filter= q field value)

Filters where field = value. A map may be used for checking multiple equalities.

filter> clj

(filter> q field value)

Filters where field > value.

filter>= clj

(filter>= q field value)

Filters where field >= value.

firestore clj

(firestore q)

Gets the Firestore instance associated with this query.

geo-point clj

(geo-point [lat lon])

Creates a geocode object from a lat lon pair.

id clj

(id d)

Returns the id of a CollectionReference, DocumentReference or DocumentSnapshot.

inc clj

(inc v)

Used with set! and merge!. Increments a numeric field.

lat-lon clj

(lat-lon g)

Returns a lat lon pair from a GeoPoint.

limit clj

(limit q n)

Limits results to a certain number.

map! clj

(map! q f & args)

Updates all docs in a vector or query by applying a function to them

mark-for-deletion clj

(mark-for-deletion)

Used with set! and merge!. A sentinel value that marks a field for deletion.

merge clj

(merge context dr m)

(merge context dr m updated-time)

Updates field of a document in a batched write/transaction context.

merge! clj

(merge! dr m)

(merge! dr m updated-time)

Updates fields of a document. Accepts an updated-time as precondition.

offset clj

(offset q n)

Skips the first n results.

order-by clj

(order-by q & ordering)

Orders by a sequence of fields with optional directions. Notice that ordering by multiple fields requires creation of a composite index.

parent clj

(parent dr)

A reference to the collection to which this document belongs to.

path clj

(path r)

A string representing the path of the referenced document or collection.

pull clj

(pull q)

(pull q t)

Pulls data from a DocumentReference or Query, possibly inside a transaction context.

pull-doc clj

Pulls clojure data from a DocumentReference.

pull-docs clj

(pull-docs drs)

(pull-docs drs t)

Pulls clojure data from a sequence of DocumentReferences, possibly inside a transaction context.

pull-query clj

Pulls results from a Query as clojure data.

pullv clj

Pulls query results as a vector of document data.

pullv-with-ids clj

Pulls query results as a vector of pairs. Each pair has an id and document data

purge! clj

(purge! root)

(purge! root batch-size)

If a document, deletes it and all its subcollections recursively. If a collection or query, purges all its documents. Operates in batches.

qs->plain-map clj

(qs->plain-map s)

Represents a QuerySnapshot as a plain map whose keys are the document ids.

qs->plainv clj

(qs->plainv s)

Represents a QuerySnapshot as a plain vector of document data.

qs->plainv-with-ids clj

(qs->plainv-with-ids s)

Represents a QuerySnapshot as a plain vector of [id doc] pairs.

query-snap clj

(query-snap q)

(query-snap q t)

Gets a QuerySnapshot given a Query and possibly a Transaction.

query-snap->doc-snaps clj

(query-snap->doc-snaps qs)

Gets DocumentSnapshots from a QuerySnapshot

range clj

(range q start end)

Gets a range

read-time clj

(read-time q)

The time at which this snapshot was read.

ref clj

(ref ds)

Gets a reference to the document this snapshot refers to.

select clj

(select q & fields)

Selects given fields

server-timestamp clj

(server-timestamp)

Used with set! and merge!. Timestamp for when the update operation is performed on server.

set clj

(set context dr m)

(set context dr m kw)

(set context dr m kw args)

Creates or overwrites a document in a batched write/transaction context.

set! clj

(set! dr m)

(set! dr m kw)

(set! dr m kw args)

Creates or overwrites a document.

snap clj

(snap q)

(snap q t)

Gets a DocumentSnapshot or QuerySnapshot given a DocumentReference or Query.

snap->plain clj

(snap->plain s)

Gets a DocumentSnapshot/CollectionSnapshot/QuerySnapshot's underlying data.

start-after clj

(start-after q & args)

Starts results after the provided document, or at the provided fields relative to the order of the query.

start-at clj

(start-at q & args)

Starts results at the provided document, or at the provided fields relative to the order of the query.

subdocs clj

(subdocs dr)

A lazy sequence including given document and all documents in its subcollections.

transact! clj

(transact! db f)

(transact! db f {:keys [attempts executor] :as options})

Performs a transaction. Optionally, you can specify an executor and the maximum number of attemps.

update! clj

(update! dr f & args)

Updates a document by applying a function to it.

update-field! clj

(update-field! dr field f & args)

Updates a single field of a document by applying a function to it.

update-time clj

(update-time ds)

The time at which this document was last updated.