Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Response

• repeated Frame frames = 1

A [Datum] is a chunk of data that can be serialized to disk or returned to the user in a Response. Currently we only support JSON types, but we may support other types in the future (e.g., a date type or an integer type).

Used in: Datum.AssocPair, Response, Term

• optional Datum.DatumType type = 1

• optional bool r_bool = 2

• optional double r_num = 3

• optional string r_str = 4

• repeated Datum r_array = 5

• repeated Datum.AssocPair r_object = 6

Used in: Datum

• optional string key = 1

• optional Datum val = 2

Used in: Datum

• R_NULL = 1

• R_BOOL = 2

• R_NUM = 3

  a double

• R_STR = 4

• R_ARRAY = 5

• R_OBJECT = 6

A backtrace frame (see `backtrace` in Response below)

Used in: Backtrace

• optional Frame.FrameType type = 1

• optional int64 pos = 2

  The index of the positional argument.

• optional string opt = 3

  The name of the optional argument.

Used in: Frame

• POS = 1

  Error occured in a positional argument.

• OPT = 2

  Error occured in an optional argument.

You send one of: * A [START] query with a [Term] to evaluate and a unique-per-connection token. * A [CONTINUE] query with the same token as a [START] query that returned [SUCCESS_PARTIAL] in its [Response]. * A [STOP] query with the same token as a [START] query that you want to stop.

• optional Query.QueryType type = 1

• optional Term query = 2

  A [Term] is how we represent the operations we want a query to perform.

  only present when [type] = [START]

• optional int64 token = 3

• optional bool OBSOLETE_noreply = 4

  This flag is ignored on the server. `noreply` should be added to `global_optargs` instead (the key "noreply" should map to either true or false).

• repeated Query.AssocPair global_optargs = 6

Used in: Query

• optional string key = 1

• optional Term val = 2

Used in: Query

• START = 1

  Start a new query.

• CONTINUE = 2

  Continue a query that returned [SUCCESS_PARTIAL]

• STOP = 3

  (see [Response]).

  Stop a query partway through executing.

You get back a response with the same [token] as your query.

• optional Response.ResponseType type = 1

• optional int64 token = 2

  Indicates what [Query] this response corresponds to.

• repeated Datum response = 3

  [response] contains 1 RQL datum if [type] is [SUCCESS_ATOM], or many RQL data if [type] is [SUCCESS_SEQUENCE] or [SUCCESS_PARTIAL]. It contains 1 error message (of type [R_STR]) in all other cases.

• optional Backtrace backtrace = 4

  Contains n [Frame]s when you get back an error.

Used in: Response

• SUCCESS_ATOM = 1

  These response types indicate success.

  Query returned a single RQL datatype.

• SUCCESS_SEQUENCE = 2

  Query returned a sequence of RQL datatypes.

• SUCCESS_PARTIAL = 3

  Query returned a partial sequence of RQL

• CLIENT_ERROR = 16

  These response types indicate failure.

  Means the client is buggy. An example is if the

• COMPILE_ERROR = 17

  client sends a malformed protobuf, or tries to send [CONTINUE] for an unknown token.

  Means the query failed during parsing or type

• RUNTIME_ERROR = 18

  checking. For example, if you pass too many arguments to a function.

  Means the query failed at runtime. An example is

A [Term] is either a piece of data (see **Datum** above), or an operator and its operands. If you have a [Datum], it's stored in the member [datum]. If you have an operator, its positional arguments are stored in [args] and its optional arguments are stored in [optargs]. A note about type signatures: We use the following notation to denote types: arg1_type, arg2_type, argrest_type... -> result_type So, for example, if we have a function `avg` that takes any number of arguments and averages them, we might write: NUMBER... -> NUMBER Or if we had a function that took one number modulo another: NUMBER, NUMBER -> NUMBER Or a function that takes a table and a primary key of any Datum type, then retrieves the entry with that primary key: Table, DATUM -> OBJECT Some arguments must be provided as literal values (and not the results of sub terms). These are marked with a `!`. Optional arguments are specified within curly braces as argname `:` value type (e.x `{use_outdated:BOOL}`) Many RQL operations are polymorphic. For these, alterantive type signatures are separated by `|`. The RQL type hierarchy is as follows: Top DATUM NULL BOOL NUMBER STRING OBJECT SingleSelection ARRAY Sequence ARRAY Stream StreamSelection Table Database Function Ordering - used only by ORDER_BY Error

Used in: Query, Query.AssocPair, Term.AssocPair

• optional Term.TermType type = 1

• optional Datum datum = 2

  This is only used when type is DATUM.

• repeated Term args = 3

  Holds the positional arguments of the query.

• repeated Term.AssocPair optargs = 4

  Holds the optional arguments of the query.

Used in: Term

• optional string key = 1

• optional Term val = 2

Used in: Term

• DATUM = 1

  A RQL datum, stored in `datum` below.

• MAKE_ARRAY = 2

  DATUM... -> ARRAY

• MAKE_OBJ = 3

  Evaluate the terms in [optargs] and make an object

  {...} -> OBJECT

• VAR = 10

  * Compound types Takes an integer representing a variable and returns the value stored in that variable. It's the responsibility of the client to translate from their local representation of a variable to a unique integer for that variable. (We do it this way instead of letting clients provide variable names as strings to discourage variable-capturing client libraries, and because it's more efficient on the wire.)

  !NUMBER -> DATUM

• JAVASCRIPT = 11

  Takes some javascript code and executes it.

  STRING {timeout: !NUMBER} -> DATUM |

• ERROR = 12

  Takes a string and throws an error with that message. Inside of a `default` block, you can omit the first argument to rethrow whatever error you catch (this is most useful as an argument to the `default` filter optarg).

  STRING -> Error | -> Error

• IMPLICIT_VAR = 13

  Takes nothing and returns a reference to the implicit variable.

  -> DATUM

• DB = 14

  * Data Operators Returns a reference to a database.

  STRING -> Database

• TABLE = 15

  Returns a reference to a table.

  Database, STRING, {use_outdated:BOOL} -> Table | STRING, {use_outdated:BOOL} -> Table

• GET = 16

  Gets a single element from a table by its primary or a secondary key.

  Table, STRING -> SingleSelection | Table, NUMBER -> SingleSelection |

• GET_ALL = 78

  Table, STRING -> NULL | Table, NUMBER -> NULL |

  Table, DATUM..., {index:!STRING} => ARRAY

• EQ = 17

  Simple DATUM Ops

  DATUM... -> BOOL

• NE = 18

  DATUM... -> BOOL

• LT = 19

  DATUM... -> BOOL

• LE = 20

  DATUM... -> BOOL

• GT = 21

  DATUM... -> BOOL

• GE = 22

  DATUM... -> BOOL

• NOT = 23

  BOOL -> BOOL

• ADD = 24

  ADD can either add two numbers or concatenate two arrays.

  NUMBER... -> NUMBER | STRING... -> STRING

• SUB = 25

  NUMBER... -> NUMBER

• MUL = 26

  NUMBER... -> NUMBER

• DIV = 27

  NUMBER... -> NUMBER

• MOD = 28

  NUMBER, NUMBER -> NUMBER

• APPEND = 29

  DATUM Array Ops Append a single element to the end of an array (like `snoc`).

  ARRAY, DATUM -> ARRAY

• PREPEND = 80

  Prepend a single element to the end of an array (like `cons`).

  ARRAY, DATUM -> ARRAY

• DIFFERENCE = 95

  Remove the elements of one array from another array.

  ARRAY, ARRAY -> ARRAY

• SET_INSERT = 88

  DATUM Set Ops Set ops work on arrays. They don't use actual sets and thus have performance characteristics you would expect from arrays rather than from sets. All set operations have the post condition that they array they return contains no duplicate values.

  ARRAY, DATUM -> ARRAY

• SET_INTERSECTION = 89

  ARRAY, ARRAY -> ARRAY

• SET_UNION = 90

  ARRAY, ARRAY -> ARRAY

• SET_DIFFERENCE = 91

  ARRAY, ARRAY -> ARRAY

• SLICE = 30

  Sequence, NUMBER, NUMBER -> Sequence

• SKIP = 70

  Sequence, NUMBER -> Sequence

• LIMIT = 71

  Sequence, NUMBER -> Sequence

• INDEXES_OF = 87

  Sequence, DATUM -> Sequence | Sequence, Function(1) -> Sequence

• CONTAINS = 93

  Sequence, DATUM -> BOOL

• GET_FIELD = 31

  Stream/Object Ops Get a particular field from an object, or map that over a sequence.

  OBJECT, STRING -> DATUM

• KEYS = 94

  | Sequence, STRING -> Sequence Return an array containing the keys of the object.

  OBJECT -> ARRAY

• HAS_FIELDS = 32

  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.

  OBJECT, STRING... -> BOOL

• WITH_FIELDS = 96

  x.with_fields(...) <=> x.has_fields(...).pluck(...)

  Sequence, STRING... -> Sequence

• PLUCK = 33

  Get a subset of an object by selecting some attributes to preserve, or map that over a sequence. (Both pick and pluck, polymorphic.)

  Sequence, STRING... -> Sequence | OBJECT, STRING... -> OBJECT

• WITHOUT = 34

  Get a subset of an object by selecting some attributes to discard, or map that over a sequence. (Both unpick and without, polymorphic.)

  Sequence, STRING... -> Sequence | OBJECT, STRING... -> OBJECT

• MERGE = 35

  Merge objects (right-preferential)

  OBJECT... -> OBJECT | Sequence -> Sequence

• BETWEEN = 36

  Sequence Ops Get all elements of a sequence between two values.

  StreamSelection, DATUM, DATUM, {:index:!STRING} -> StreamSelection

• REDUCE = 37

  Sequence, Function(2), {base:DATUM} -> DATUM

• MAP = 38

  Sequence, Function(1) -> Sequence

• FILTER = 39

  Filter a sequence with either a function or a shortcut object (see API docs for details). The body of FILTER is wrapped in an implicit `.default(false)`, and you can change the default value by specifying the `default` optarg. If you make the default `r.error`, all errors caught by `default` will be rethrown as if the `default` did not exist.

  Sequence, Function(1), {default:DATUM} -> Sequence |

• CONCATMAP = 40

  Sequence, OBJECT, {default:DATUM} -> Sequence Map a function over a sequence and then concatenate the results together.

  Sequence, Function(1) -> Sequence

• ORDERBY = 41

  Order a sequence based on one or more attributes.

  Sequence, (!STRING | Ordering)... -> Sequence

• DISTINCT = 42

  Get all distinct elements of a sequence (like `uniq`).

  Sequence -> Sequence

• COUNT = 43

  Count the number of elements in a sequence, or only the elements that match a given filter.

  Sequence -> NUMBER | Sequence, DATUM -> NUMBER | Sequence, Function(1) -> NUMBER

• IS_EMPTY = 86

  Sequence -> BOOL

• UNION = 44

  Take the union of multiple sequences (preserves duplicate elements! (use distinct)).

  Sequence... -> Sequence

• NTH = 45

  Get the Nth element of a sequence.

  Sequence, NUMBER -> DATUM

• GROUPED_MAP_REDUCE = 46

  Takes a sequence, and three functions: - A function to group the sequence by. - A function to map over the groups. - A reduction to apply to each of the groups.

  Sequence, Function(1), Function(1), Function(2), {base:DATUM} -> ARRAY

• GROUPBY = 47

  Groups a sequence by one or more attributes, and then applies a reduction. The third argument is a special object literal giving the kind of operation to be performed and any necessary arguments. At present, GROUPBY suports the following operations * {'COUNT': <ignored>} - count the size of the group * {'SUM': attr} - sum the values of the given attribute across the group * {'AVG': attr} - average the values of the given attribute across the group

  Sequence, ARRAY, !GROUP_BY_OBJECT -> Sequence

• INNER_JOIN = 48

  Sequence, Sequence, Function(2) -> Sequence

• OUTER_JOIN = 49

  Sequence, Sequence, Function(2) -> Sequence

• EQ_JOIN = 50

  An inner-join that does an equality comparison on two attributes.

  Sequence, !STRING, Sequence, {index:!STRING} -> Sequence

• ZIP = 72

  Sequence -> Sequence

• INSERT_AT = 82

  Array Ops Insert an element in to an array at a given index.

  ARRAY, NUMBER, DATUM -> ARRAY

• DELETE_AT = 83

  Remove an element at a given index from an array.

  ARRAY, NUMBER -> ARRAY |

• CHANGE_AT = 84

  ARRAY, NUMBER, NUMBER -> ARRAY Change the element at a given index of an array.

  ARRAY, NUMBER, DATUM -> ARRAY

• SPLICE_AT = 85

  Splice one array in to another array.

  ARRAY, NUMBER, ARRAY -> ARRAY

• COERCE_TO = 51

  * Type Ops Coerces a datum to a named type (e.g. "bool"). If you previously used `stream_to_array`, you should use this instead with the type "array".

  Top, STRING -> Top

• TYPEOF = 52

  Returns the named type of a datum (e.g. TYPEOF(true) = "BOOL")

  Top -> STRING

• UPDATE = 53

  * Write Ops (the OBJECTs contain data about number of errors etc.) Updates all the rows in a selection. Calls its Function with the row to be updated, and then merges the result of that call.

  StreamSelection, Function(1), {non_atomic:BOOL, durability:STRING} -> OBJECT |

• DELETE = 54

  SingleSelection, Function(1), {non_atomic:BOOL, durability:STRING} -> OBJECT | StreamSelection, OBJECT, {non_atomic:BOOL, durability:STRING} -> OBJECT | SingleSelection, OBJECT, {non_atomic:BOOL, durability:STRING} -> OBJECT Deletes all the rows in a selection.

  StreamSelection, {durability:STRING} -> OBJECT | SingleSelection -> OBJECT

• REPLACE = 55

  Replaces all the rows in a selection. Calls its Function with the row to be replaced, and then discards it and stores the result of that call.

  StreamSelection, Function(1), {non_atomic:BOOL} -> OBJECT | SingleSelection, Function(1), {non_atomic:BOOL, durability:STRING} -> OBJECT

• INSERT = 56

  Inserts into a table. If `upsert` is true, overwrites entries with the same primary key (otherwise errors).

  Table, OBJECT, {upsert:BOOL} -> OBJECT | Table, Sequence, {upsert:BOOL, durability:STRING} -> OBJECT

• DB_CREATE = 57

  * Administrative OPs Creates a database with a particular name.

  STRING -> OBJECT

• DB_DROP = 58

  Drops a database with a particular name.

  STRING -> OBJECT

• DB_LIST = 59

  Lists all the databases by name. (Takes no arguments)

  -> ARRAY

• TABLE_CREATE = 60

  Creates a table with a particular name in a particular database. (You may omit the first argument to use the default database.)

  Database, STRING, {datacenter:STRING, primary_key:STRING, cache_size:NUMBER, durability:STRING} -> OBJECT

• TABLE_DROP = 61

  STRING, {datacenter:STRING, primary_key:STRING, cache_size:NUMBER, durability:STRING} -> OBJECT Drops a table with a particular name from a particular database. (You may omit the first argument to use the default database.)

  Database, STRING -> OBJECT

• TABLE_LIST = 62

  STRING -> OBJECT Lists all the tables in a particular database. (You may omit the first argument to use the default database.)

  Database -> ARRAY

• INDEX_CREATE = 75

  * Secondary indexes OPs Creates a new secondary index with a particular name and definition.

  Table, STRING, Function(1) -> OBJECT

• INDEX_DROP = 76

  Drops a secondary index with a particular name from the specified table.

  Table, STRING -> OBJECT

• INDEX_LIST = 77

  Lists all secondary indexes on a particular table.

  Table -> ARRAY

• FUNCALL = 64

  * Control Operators Calls a function on data

  Function(*), DATUM... -> DATUM

• BRANCH = 65

  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).

  BOOL, Top, Top -> Top

• ANY = 66

  Returns true if any of its arguments returns true (short-circuits). (Like `or` in most languages.)

  BOOL... -> BOOL

• ALL = 67

  Returns true if all of its arguments return true (short-circuits). (Like `and` in most languages.)

  BOOL... -> BOOL

• FOREACH = 68

  Calls its Function with each entry in the sequence and executes the array of terms that Function returns.

  Sequence, Function(1) -> OBJECT

• FUNC = 69

  An anonymous function. Takes an array of numbers representing variables (see [VAR] above), and a [Term] to execute with those in scope. Returns a function that may be passed an array of arguments, then executes the Term with those bound to the variable names. The user will never construct this directly. We use it internally for things like `map` which take a function. The "arity" of a [Function] is the number of arguments it takes. For example, here's what `_X_.map{|x| x+2}` turns into: Term { type = MAP; args = [_X_, Term { type = Function; args = [Term { type = DATUM; datum = Datum { type = R_ARRAY; r_array = [Datum { type = R_NUM; r_num = 1; }]; }; }, Term { type = ADD; args = [Term { type = VAR; args = [Term { type = DATUM; datum = Datum { type = R_NUM; r_num = 1}; }]; }, Term { type = DATUM; datum = Datum { type = R_NUM; r_num = 2; }; }]; }]; }];

  ARRAY, Top -> ARRAY -> Top

• ASC = 73

  Indicates to ORDER_BY that this attribute is to be sorted in ascending order.

  !STRING -> Ordering

• DESC = 74

  Indicates to ORDER_BY that this attribute is to be sorted in descending order.

  !STRING -> Ordering

• INFO = 79

  Gets info about anything. INFO is most commonly called on tables.

  Top -> OBJECT

• MATCH = 97

  `a.match(b)` returns a match object if the string `a` matches the regular expression `b`.

  STRING, STRING -> DATUM

• SAMPLE = 81

  Select a number of elements from sequence with uniform distribution.

  Sequence, NUMBER -> Sequence

• DEFAULT = 92

  Evaluates its first argument. If that argument returns NULL or throws an error related to the absence of an expected value (for instance, accessing a non-existent field or adding NULL to an integer), DEFAULT will either return its second argument or execute it if it's a function. If the second argument is a function, it will be passed either the text of the error or NULL as its argument.

  Top, Top -> Top

• JSON = 98

  Parses its first argument as a json string and returns it as a datum.

  STRING -> DATUM

This enum contains the magic numbers for your version. See **THE HIGH-LEVEL VIEW** for what to do with it.

We need to wrap it like this for some

(message has no fields)

non-conforming protobuf libraries

• V0_1 = 1063369270

• V0_2 = 1915781601