RethinkDB.Query.Selection
ReQL methods for selecting data.
Summary↑
db(arg) | |
db(arg, opts) | Reference a database |
get(left, right) | |
get(left, right, opts) | Get a document by primary key |
get_all(seq, args) | |
get_all(seq, args, opts) | Get all documents where the given value matches the value of the requested index |
table(arg) | |
table(arg, opts) | Return all documents in a table. Other commands may be chained after table to return a subset of documents (such as get and filter) or perform further processing |
table(left, right, opts) |
Functions
Specs:
Reference a database.
Specs:
Get a document by primary key.
If no document exists with that primary key, get will return nil.
Specs:
- get_all(RethinkDB.Query.t, RethinkDB.Query.reql_array) :: RethinkDB.Query.t
Get all documents where the given value matches the value of the requested index.
Specs:
Return all documents in a table. Other commands may be chained after table to return a subset of documents (such as get and filter) or perform further processing.
There are two optional arguments.
- useOutdated: if true, this allows potentially out-of-date data to be returned, with potentially faster reads. It also allows you to perform reads from a secondary replica if a primary has failed. Default false.
- identifierFormat: possible values are name and uuid, with a default of name. If set to uuid, then system tables will refer to servers, databases and tables by UUID rather than name. (This only has an effect when used with system tables.)
Specs:
- table(RethinkDB.Query.t, RethinkDB.Query.reql_string, RethinkDB.Query.reql_opts) :: RethinkDB.Query.t