firestore-clj.core — polvo/firestore-clj 0.1.1

->atom clj

(->atom q)

(->atom q error-handler)

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

add! clj

(add! c m)

Adds a document to a collection. Its id will be automatically generated. This is a blocking operation.

add-listener clj

(add-listener q f)

Adds a snapshot listener to a DocumentReference/CollectionReference/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! d & kvs)

Associates new keys and values.

client-with-creds clj

(client-with-creds creds-path)

Creates a client from a credentials JSON file.

collection clj

(collection db coll-name)

Returns a CollectionReference for the collection of given name.

contains clj

(contains q field value)

Filters where field contains value.

contains-any clj

(contains-any q field arr)

Filters where field contains one of the values in arr.

default-client clj

(default-client project-id)

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

delete! clj

(delete! d)

Deletes a document.

detach clj

(detach a)

Detaches an atom built with ->atom.

dissoc! clj

(dissoc! d & ks)

Deletes keys.

document clj

(document c id)

Gets a document from a collection reference.

field-delete clj

(field-delete)

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

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.

id clj

(id d)

Returns the id of a document, given a reference.

in clj

(in q field arr)

Filters where field is one of the values in arr.

inc clj

(inc v)

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

merge! clj

(merge! d m)

Updates fields of a document.

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.

pull clj

(pull q)

Pulls data from a DocumentReference, CollectionReference or Query.

server-timestamp clj

(server-timestamp)

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

set! clj

(set! c doc-name m)

Creates or overwrites a document. This is a blocking operation.

snapshot->data clj

(snapshot->data s)

Gets a DocumentReference/CollectionReference/Query's underlying data.

take clj

(take q n)

Limits results to a certain number.