README
¶
Table of Contents generated with DocToc
fuego
A command-line firestore client
Installation
Precompiled binaries
Download one of the precompiled binaries from the latest release. (builts available for windows, linux, macintosh/darwin)
Building it locally
If you are comfortable building programs, you can build fuego yourself using go:
git clone https://github.com/sgarciac/fuego.git
cd fuego
go build . # and 'go install .' if you want
./fuego --help
Usage
Authentication
You'll need a Service Account key file to be able to access your project's firestore database. To create a service account private key file, if you don't have one, go to your firebase project console, then Project settings and then click on the Service accounts tab and generate a new private key.
Once you have your service account key file, fuego will be able to find it using one of the following options:
- Use the
--credentialsflag everytime you execute fuego, i.e.:
fuego --credentials ./my-account-service-private-key.json get mycollection mydocumentid
or
- Via the GOOGLE_APPLICATION_CREDENTIALS environment variable:
export GOOGLE_APPLICATION_CREDENTIALS=./my-account-service-private-key.json
fuego get mycollection mydocumentid
Project
Firestore databases belong to projects. The google application credentials file
usually define the project that firestore will work on. You can however, if
necessary, define the project using the global option --projectid.
Firestore emulator usage
If you need to use fuego with the firestore emulator instead of a real firestore
database, set the FIRESTORE_EMULATOR_HOST environment variable to something
appropriate (usually, localhost:8080). NOTE: When using the emulator, you
are likely not using a GOOGLE_APPLICATION_CREDENTIALS file. Therefore, no
project will be defined. You can set a project using the global option
--projectid, otherwise it will use 'default' as the project identifier.
List collections
fuego collections
Will return the list of projet's collections.
Writing and reading data
You can add new documents, using JSON:
fuego add people '{"name": "sergio", "age": 41}'
# Rv7ZfnLQWprdXuulqMdf <- fuego prints the ID of the newly created document
Of fetch them, using the ID:
fuego get people Rv7ZfnLQWprdXuulqMdf
# {
# "age": 41,
# "name": "sergio"
# }
You can also replace an existing document:
fuego set people/Rv7ZfnLQWprdXuulqMdf '{"name": "sergio", "age": 42}' # It's my birthday!
Note: we can either use the arguments collection-path document-id json-data or document-path json-data. This is also the case for the
delete and the get commands.
In both add and set commands, the document argument can be either a
json string (if it starts with the character {) or a path to a json file, i.e.:
fuego add animals ./dog.json
To delete a document:
fuego delete people/Rv7ZfnLQWprdXuulqMdf
note: this won't delete any subcollection under the document.
To update an existing document:
fuego set --merge people Rv7ZfnLQWprdXuulqMdf '{"location": "unknown"}'
# Rv7ZfnLQWprdXuulqMdf <- fuego prints the ID of the updated document
fuego get people Rv7ZfnLQWprdXuulqMdf
# {
# "age": 41,
# "location": "unknonw",
# "name": "sergio"
# }
A note on types
fuego read and write commands are constrained by JSON data types: string, number, object, array and boolean, which don't cover all of firestore data types.
When writing data, you can make fuego treat all strings that match the rfc3339 datetime format as firestore timestamps, using the --timestamp (or --ts) flag. For example:
fuego add --ts dates '{"randomdate": "2012-11-01T22:08:41+00:00"}'
will add a new document whose field named "randomdate" is a timestamp and not a string.
Subcollections
You can work on sub-collections using the full path with "/"s as separators. For example:
fuego query countries/france/cities
Queries
Let's explain queries by example. First, we'll create a collection of physics nobel laureates,
fuego add nobel '{"name": "Arthur Ashkin", "year": 2018, "birthplace": {"country":"USA", "city": "New York"}}'
fuego add nobel '{"name": "Gerard Mourou", "year": 2018, "birthplace": {"country":"FRA", "city": "Albertville"}}'
fuego add nobel '{"name": "Donna Strickland", "year": 2018, "birthplace": {"country":"CAN", "city": "Guelph"}}'
fuego add nobel '{"name": "Rainer Weiss", "year": 2017, "birthplace": {"country":"DEU", "city": "Berlin"}}'
fuego add nobel '{"name": "Kip Thorne", "year": 2017, "birthplace": {"country":"USA", "city": "Logan"}}'
fuego add nobel '{"name": "Barry Barish", "year": 2017, "birthplace": {"country":"USA", "city": "Omaha"}}'
fuego add nobel '{"name": "David Thouless", "year": 2016, "birthplace": {"country":"GBR", "city": "Bearsden"}}'
We can query the full collection:
fuego query nobel
# Prints all our nobel laureates like this:
# [
# {
# "CreateTime": "2019-02-26T02:39:45.293936Z",
# "Data": {
# "birthplace": {
# "city": "Bearsden",
# "country": "GBR"
# },
# "name": "David Thouless",
# "year": 2016
# },
# "ID": "BJseSVoBatOOt8gcwZWx",
# "ReadTime": "2019-02-26T02:55:19.419627Z",
# "UpdateTime": "2019-02-26T02:39:45.293936Z"
# },
# .... etc
Which will fetch and display the documents in the collection, unfiltered. By default, fuego will fetch only 100 documents. You can change the limit using the --limit flag.
You can also order the results using the --orderby and --orderdir
flags. For example, to sort our nobel laureates by country of origin, in
ascending order:
fuego query --orderby birthplace.country --orderdir ASC nobel
You can add filters, using the firestore supported operators (>, <, >=, <=, ==, in, array-contains or array-contains-any). You can combine several filters in a single query. For example, to get the 2018 nobel laureates from the USA:
fuego query nobel 'birthplace.country == "USA"' 'year == 2018'
which will print:
[
{
"CreateTime": "2019-02-26T02:14:02.692077Z",
"Data": {
"birthplace": {
"city": "New York",
"country": "USA"
},
"name": "Arthur Ashkin",
"year": 2018
},
"ID": "glHCUu7EZ3gkuDaVlXqv",
"ReadTime": "2019-02-26T03:00:15.576398Z",
"UpdateTime": "2019-02-26T02:59:55.889775Z"
}
]
Let's say we want to find the least recent nobel from the USA, we can write the following query:
fuego query --limit 1 --orderby year --orderdir ASC nobel "birthplace.country == 'USA'"
oops, we get the following error from the server, because our query needs an index to work:
rpc error: code = FailedPrecondition desc = The query requires an index.
You can create it here:
https://console.firebase.google.com/project/myproject/database/firestore/indexes?create_index=EgVub2JlbBoWChJiaXJ0aH....
After creating the index, we re-run the query and now we obtain:
[
{
"CreateTime": "2019-02-26T02:39:44.458647Z",
"Data": {
"birthplace": {
"city": "Omaha",
"country": "USA"
},
"name": "Barry Barish",
"year": 2017
},
"ID": "ainH3nkOA2xusEBON2An",
"ReadTime": "2019-02-26T03:12:07.156643Z",
"UpdateTime": "2019-02-26T02:39:44.458647Z"
}
]
Value and field path types in filters
I our previous examples, all the segments of the path part of a filter contained alphanumeric or the _ character and did not start with a number. When this conditions are met, they can be written unquoted. Otherwise, they need to be unquoted.
fuego query weirdcollection 'really." ".strage." but valid ".fieldname == "even blank keys are valid"'
As for values, numeric, string, boolean (true or false) and timestamp values are supported in filters. Examples of queries:
"age >= 34", "name == 'paul'", "married == true", and "birthday == 1977-06-28T04:00:00Z"
Note that timestamps values should use the RFC3339 format and should not be quoted. Boolean values are represented by the unquoted true and false strings.
Arrays values should be expressed as in the following example. Notice that items are separated by space:
fuego query cities 'name in ["bogota" "cali" "medellin"]'
Selecting specific fields
Use the --select flag to explicitely ask for the specific fields you want to be retrieved (you can define many using several --select)
fuego query --select name --select year --limit 1 --orderby year --orderdir ASC nobel "birthplace.country == 'USA'"
Pagination of query results
There are two ways to page through query results.
First you can use the firestore pagination parameters to manually page through results. Combining --limit with the flags --startat, --startafter, --endat, and --endbefore, which all accept the ID of a document.
Second you can use the --batch parameter. This will cause fuego to do the pagination internally. This is helpful for very big queries which hit the firestore query timeout (about a minute). Very likely you will have to increase the --limit parameter from its default.
Group queries
You can make group queries by using the -g flag.
Contributing
See the HACKING file for some guidance on how to contribute.
Documentation
¶
There is no documentation for this package.
Source Files