package
3.0.5+incompatible
Repository: https://github.com/rethinkdb/rethinkdb-go.git
Documentation: pkg.go.dev
# Constants
No description provided by the author
No description provided by the author
This [DatumType] will only be used if [accepts_r_json] is set to [true] in [Query].
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
(see [Response]).
The stream is a point changefeed stream (e.g.
These response types indicate failure.
client sends a malformed protobuf, or tries to send [CONTINUE] for an unknown token.
The stream is a changefeed stream and includes notes on what state the changefeed stream is in (e.g.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The stream is an order_by_limit changefeed stream (e.g.
No description provided by the author
No description provided by the author
No description provided by the author
checking.
The stream is a changefeed stream (e.g.
No description provided by the author
These response types indicate success.
No description provided by the author
No description provided by the author
The stream is a union of multiple changefeed types that can't be collapsed to a single type (e.g.
No description provided by the author
datatypes.
ADD can either add two numbers or concatenate two arrays.
Returns true if all of its arguments return true (short-circuits).
DATUM Array Ops Append a single element to the end of an array (like `snoc`).
No description provided by the author
No description provided by the author
Indicates to ORDER_BY that this attribute is to be sorted in ascending order.
No description provided by the author
No description provided by the author
With the newer version, clients should use `r.minval` and `r.maxval` for unboundedness.
Sequence Ops Get all elements of a sequence between two values.
BINARY is client-only at the moment, it is not supported on the server.
do NTH or GET_FIELD depending on target object.
Executes its first argument, and returns its second argument if it got [true] or its third argument if it got [false] (like an `if` statement).
No description provided by the author
ARRAY, NUMBER, NUMBER -> ARRAY Change the element at a given index of an array.
No description provided by the author
No description provided by the author
* Type Ops Coerces a datum to a named type (e.g.
Sequence, OBJECT, {default:DATUM} -> Sequence Map a function over a sequence and then concatenate the results together.
-> ARRAY Returns the row in the `rethinkdb.table_config` or `rethinkdb.db_config` table that corresponds to the given database or table.
No description provided by the author
Count the number of elements in a sequence, or only the elements that match a given filter.
Retrieves the date portion of a time.
A RQL datum, stored in `datum` below.
No description provided by the author
No description provided by the author
No description provided by the author
* Data Operators Returns a reference to a database.
* Administrative OPs Creates a database with a particular name.
Drops a database with a particular name.
Lists all the databases by name.
No description provided by the author
Evaluates its first argument.
SingleSelection, Function(1), {non_atomic:BOOL, durability:STRING, return_changes:BOOL} -> OBJECT | StreamSelection, OBJECT, {non_atomic:BOOL, durability:STRING, return_changes:BOOL} -> OBJECT | SingleSelection, OBJECT, {non_atomic:BOOL, durability:STRING, return_changes:BOOL} -> OBJECT Deletes all the rows in a selection.
Remove an element at a given index from an array.
Indicates to ORDER_BY that this attribute is to be sorted in descending order.
Remove the elements of one array from another array.
No description provided by the author
Get all distinct elements of a sequence (like `uniq`).
No description provided by the author
No description provided by the author
a.during(b, c) returns whether a is in the range [b, c).
Returns a time given seconds since epoch in UTC.
Simple DATUM Ops.
An inner-join that does an equality comparison on two attributes.
Takes a string and throws an error with that message.
No description provided by the author
No description provided by the author
Filter a sequence with either a function or a shortcut object (see API docs for details).
No description provided by the author
No description provided by the author
Calls its Function with each entry in the sequence and executes the array of terms that Function returns.
No description provided by the author
An anonymous function.
* Control Operators Calls a function on data.
No description provided by the author
No description provided by the author
STRING, {read_mode:STRING, identifier_format:STRING} -> Table Gets a single element from a table by its primary or a secondary key.
Table, STRING -> NULL | Table, NUMBER -> NULL |.
Stream/Object Ops Get a particular field from an object, or map that over a sequence.
No description provided by the author
No description provided by the author
Set global, database, or table-specific permissions.
SEQUENCE, STRING -> GROUPED_SEQUENCE | SEQUENCE, FUNCTION -> GROUPED_SEQUENCE.
No description provided by the author
Check whether an object contains all the specified fields, or filters a sequence so that all objects inside of it contain all the specified fields.
No description provided by the author
Takes an HTTP URL and gets it.
Takes nothing and returns a reference to the implicit variable.
Puts a time into an ISO 8601 timezone.
No description provided by the author
* Secondary indexes OPs Creates a new secondary index with a particular name and definition.
Drops a secondary index with a particular name from the specified table.
Lists all secondary indexes on a particular table.
Renames the given index to a new name.
Gets information about whether or not a set of indexes are ready to be accessed.
Blocks until a set of indexes are ready to be accessed.
Gets info about anything.
No description provided by the author
Inserts into a table.
Array Ops Insert an element in to an array at a given index.
No description provided by the author
No description provided by the author
Parses its first arguments as an ISO 8601 time and returns it as a datum.
Constants for ISO 8601 months.
Takes some javascript code and executes it.
Parses its first argument as a json string and returns it as a datum.
No description provided by the author
No description provided by the author
| Sequence, STRING -> Sequence Return an array containing the keys of the object.
No description provided by the author
No description provided by the author
No description provided by the author
Indicates to MERGE to replace, or remove in case of an empty literal, the other object rather than merge it.
No description provided by the author
No description provided by the author
Evaluate the terms in [optargs] and make an object.
No description provided by the author
No description provided by the author
`a.match(b)` returns a match object if the string `a` matches the regular expression `b`.
No description provided by the author
No description provided by the author
No description provided by the author
Merge objects (right-preferential).
No description provided by the author
No description provided by the author
Constants for specifying key ranges.
No description provided by the author
Constants for ISO 8601 days of the week.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The time the query was received by the server.
Get the Nth element of a sequence.
Creates an object.
No description provided by the author
No description provided by the author
Returns true if any of its arguments returns true (short-circuits).
Order a sequence based on one or more attributes.
No description provided by the author
Get a subset of an object by selecting some attributes to preserve, or map that over a sequence.
No description provided by the author
No description provided by the author
No description provided by the author
Prepend a single element to the end of an array (like `cons`).
Takes a range of numbers and returns a random number within the range.
No description provided by the author
dry_run:BOOLEAN] } -> OBJECT Database|Table, {shards:NUMBER, replicas:OBJECT [, primary_replica_tag:STRING, nonvoting_replica_tags:ARRAY, dry_run:BOOLEAN] } -> OBJECT Table, {emergency_repair:STRING, dry_run:BOOLEAN} -> OBJECT Balances the table's shards but leaves everything else the same.
Database -> OBJECT Generates a new config for the given table, or all tables in the given database The `shards` and `replicas` arguments are required.
No description provided by the author
Replaces all the rows in a selection.
No description provided by the author
Select a number of elements from sequence with uniform distribution.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DATUM Set Ops Set ops work on arrays.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Splice one array in to another array.
`str.split()` splits on whitespace `str.split(" ")` splits on spaces only `str.split(" ", 5)` splits on spaces with at most 5 results `str.split(nil, 5)` splits on whitespace with at most 5 results.
Table -> SingleSelection Returns the row in the `rethinkdb.table_status` table that corresponds to the given table.
No description provided by the author
No description provided by the author
No description provided by the author
Ensures that previously issued soft-durability writes are complete and written to disk.
Returns a reference to a table.
Creates a table with a particular name in a particular database.
Database, STRING, {primary_key:STRING, shards:NUMBER, replicas:OBJECT, primary_replica_tag:STRING} -> OBJECT STRING, {primary_key:STRING, shards:NUMBER, replicas:NUMBER, primary_replica_tag:STRING} -> OBJECT STRING, {primary_key:STRING, shards:NUMBER, replicas:OBJECT, primary_replica_tag:STRING} -> OBJECT Drops a table with a particular name from a particular database.
STRING -> OBJECT Lists all the tables in a particular database.
No description provided by the author
Construct a time from a date and optional timezone or a date+time and optional timezone.
x.time_of_day == x.date - x.
Returns the timezone of a time.
Returns seconds since epoch in UTC given a time.
No description provided by the author
Prints a time as an ISO 8601 time.
Returns the datum as a JSON string.
No description provided by the author
Returns the named type of a datum (e.g.
No description provided by the author
Take the union of multiple sequences (preserves duplicate elements! (use distinct)).
Change the case of a string.
* Write Ops (the OBJECTs contain data about number of errors etc.) Updates all the rows in a selection.
STRING {timeout: !NUMBER} -> Function(*).
Return an array containing the values of the object.
Takes an integer representing a variable and returns the value stored in that variable.
Called on a table, waits for that table to be ready for read/write operations.
No description provided by the author
x.with_fields(...) <=> x.has_fields(...).pluck(...).
Get a subset of an object by selecting some attributes to discard, or map that over a sequence.
These access the various components of a time.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
No description provided by the author
A [Datum] is a chunk of data that can be serialized to disk or returned to the user in a Response.
No description provided by the author
A backtrace frame (see `backtrace` in Response below).
You send one of: * A [START] query with a [Term] to evaluate and a unique-per-connection token.
No description provided by the author
You get back a response with the same [token] as your query.
A [Term] is either a piece of data (see **Datum** above), or an operator and its operands.
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
If `ResponseType` is `RUNTIME_ERROR`, this may be filled in with more information about the error.
ResponseNotes are used to provide information about the query response that may be useful for people writing drivers or ORMs.
No description provided by the author
No description provided by the author
The protocol to use after the handshake, specified in V0_3.
non-conforming protobuf libraries This enum contains the magic numbers for your version.