gorethink: github.com/dancannon/gorethink Index | Files | Directories

package rethinkdb

import "github.com/dancannon/gorethink"

Package rethinkdb-go implements a Go driver for RethinkDB

Current version: v3.0.2 (RethinkDB v2.3) For more in depth information on how to use RethinkDB check out the API docs at http://rethinkdb.com/api

Index

Package Files

cluster.go connection.go connection_handshake.go connection_helper.go cursor.go doc.go errors.go host.go mock.go node.go pool.go pseudotypes.go query.go query_admin.go query_aggregation.go query_control.go query_db.go query_geospatial.go query_helpers.go query_join.go query_manipulation.go query_math.go query_select.go query_string.go query_table.go query_time.go query_transformation.go query_write.go rethinkdb.go session.go utils.go

Constants

const (
    SystemDatabase = "rethinkdb"

    TableConfigSystemTable   = "table_config"
    ServerConfigSystemTable  = "server_config"
    DBConfigSystemTable      = "db_config"
    ClusterConfigSystemTable = "cluster_config"
    TableStatusSystemTable   = "table_status"
    ServerStatusSystemTable  = "server_status"
    CurrentIssuesSystemTable = "current_issues"
    UsersSystemTable         = "users"
    PermissionsSystemTable   = "permissions"
    JobsSystemTable          = "jobs"
    StatsSystemTable         = "stats"
    LogsSystemTable          = "logs"
)

Variables

var (
    // ErrNoHosts is returned when no hosts to the Connect method.
    ErrNoHosts = errors.New("no hosts provided")
    // ErrNoConnectionsStarted is returned when the driver couldn't to any of
    // the provided hosts.
    ErrNoConnectionsStarted = errors.New("no connections were made when creating the session")
    // ErrInvalidNode is returned when attempting to connect to a node which
    // returns an invalid response.
    ErrInvalidNode = errors.New("invalid node")
    // ErrNoConnections is returned when there are no active connections in the
    // clusters connection pool.
    ErrNoConnections = errors.New("rethinkdb: no connections were available")
    // ErrConnectionClosed is returned when trying to send a query with a closed
    // connection.
    ErrConnectionClosed = errors.New("rethinkdb: the connection is closed")
    // ErrQueryTimeout is returned when query context deadline exceeded.
    ErrQueryTimeout = errors.New("rethinkdb: query timeout")
)
var (
    // MinVal represents the smallest possible value RethinkDB can store
    MinVal = constructRootTerm("MinVal", p.Term_MINVAL, []interface{}{}, map[string]interface{}{})
    // MaxVal represents the largest possible value RethinkDB can store
    MaxVal = constructRootTerm("MaxVal", p.Term_MAXVAL, []interface{}{}, map[string]interface{}{})
)
var (

    // Monday is a constant representing the day of the week Monday
    Monday = constructRootTerm("Monday", p.Term_MONDAY, []interface{}{}, map[string]interface{}{})
    // Tuesday is a constant representing the day of the week Tuesday
    Tuesday = constructRootTerm("Tuesday", p.Term_TUESDAY, []interface{}{}, map[string]interface{}{})
    // Wednesday is a constant representing the day of the week Wednesday
    Wednesday = constructRootTerm("Wednesday", p.Term_WEDNESDAY, []interface{}{}, map[string]interface{}{})
    // Thursday is a constant representing the day of the week Thursday
    Thursday = constructRootTerm("Thursday", p.Term_THURSDAY, []interface{}{}, map[string]interface{}{})
    // Friday is a constant representing the day of the week Friday
    Friday = constructRootTerm("Friday", p.Term_FRIDAY, []interface{}{}, map[string]interface{}{})
    // Saturday is a constant representing the day of the week Saturday
    Saturday = constructRootTerm("Saturday", p.Term_SATURDAY, []interface{}{}, map[string]interface{}{})
    // Sunday is a constant representing the day of the week Sunday
    Sunday = constructRootTerm("Sunday", p.Term_SUNDAY, []interface{}{}, map[string]interface{}{})

    // January is a constant representing the month January
    January = constructRootTerm("January", p.Term_JANUARY, []interface{}{}, map[string]interface{}{})
    // February is a constant representing the month February
    February = constructRootTerm("February", p.Term_FEBRUARY, []interface{}{}, map[string]interface{}{})
    // March is a constant representing the month March
    March = constructRootTerm("March", p.Term_MARCH, []interface{}{}, map[string]interface{}{})
    // April is a constant representing the month April
    April = constructRootTerm("April", p.Term_APRIL, []interface{}{}, map[string]interface{}{})
    // May is a constant representing the month May
    May = constructRootTerm("May", p.Term_MAY, []interface{}{}, map[string]interface{}{})
    // June is a constant representing the month June
    June = constructRootTerm("June", p.Term_JUNE, []interface{}{}, map[string]interface{}{})
    // July is a constant representing the month July
    July = constructRootTerm("July", p.Term_JULY, []interface{}{}, map[string]interface{}{})
    // August is a constant representing the month August
    August = constructRootTerm("August", p.Term_AUGUST, []interface{}{}, map[string]interface{}{})
    // September is a constant representing the month September
    September = constructRootTerm("September", p.Term_SEPTEMBER, []interface{}{}, map[string]interface{}{})
    // October is a constant representing the month October
    October = constructRootTerm("October", p.Term_OCTOBER, []interface{}{}, map[string]interface{}{})
    // November is a constant representing the month November
    November = constructRootTerm("November", p.Term_NOVEMBER, []interface{}{}, map[string]interface{}{})
    // December is a constant representing the month December
    December = constructRootTerm("December", p.Term_DECEMBER, []interface{}{}, map[string]interface{}{})
)
var ErrEmptyResult = errors.New("The result does not contain any more rows")

Error constants

var (
    Log *logrus.Logger
)
var Row = constructRootTerm("Doc", p.Term_IMPLICIT_VAR, []interface{}{}, map[string]interface{}{})

Row returns the currently visited document. Note that Row does not work within subqueries to access nested documents; you should use anonymous functions to access those documents instead. Also note that unlike in other drivers to access a rows fields you should call Field. For example:

r.row("fieldname") should instead be r.Row.Field("fieldname")

func IsConflictErr Uses

func IsConflictErr(err error) bool

IsConflictErr returns true if the error is non-nil and the query failed due to a duplicate primary key.

func IsTypeErr Uses

func IsTypeErr(err error) bool

IsTypeErr returns true if the error is non-nil and the query failed due to a type error.

func SetTags Uses

func SetTags(tags ...string)

SetTags allows you to override the tags used when decoding or encoding structs. The driver will check for the tags in the same order that they were passed into this function. If no parameters are passed then the driver will default to checking for the rethinkdb tag (the rethinkdb tag is always included) Old-style gorethink tag is also supported but deprecated

func SetVerbose Uses

func SetVerbose(verbose bool)

SetVerbose allows the driver logging level to be set. If true is passed then the log level is set to Debug otherwise it defaults to Info.

type BetweenOpts Uses

type BetweenOpts struct {
    Index      interface{} `rethinkdb:"index,omitempty"`
    LeftBound  interface{} `rethinkdb:"left_bound,omitempty"`
    RightBound interface{} `rethinkdb:"right_bound,omitempty"`
}

BetweenOpts contains the optional arguments for the Between term

type ChangeResponse Uses

type ChangeResponse struct {
    NewValue interface{} `rethinkdb:"new_val,omitempty"`
    OldValue interface{} `rethinkdb:"old_val,omitempty"`
    State    string      `rethinkdb:"state,omitempty"`
    Error    string      `rethinkdb:"error,omitempty"`
}

ChangeResponse is a helper type used when dealing with changefeeds. The type contains both the value before the query and the new value.

type ChangesOpts Uses

type ChangesOpts struct {
    Squash              interface{} `rethinkdb:"squash,omitempty"`
    IncludeInitial      interface{} `rethinkdb:"include_initial,omitempty"`
    IncludeStates       interface{} `rethinkdb:"include_states,omitempty"`
    IncludeOffsets      interface{} `rethinkdb:"include_offsets,omitempty"`
    IncludeTypes        interface{} `rethinkdb:"include_types,omitempty"`
    ChangefeedQueueSize interface{} `rethinkdb:"changefeed_queue_size,omitempty"`
}

ChangesOpts contains the optional arguments for the Changes term

type CircleOpts Uses

type CircleOpts struct {
    NumVertices interface{} `rethinkdb:"num_vertices,omitempty"`
    GeoSystem   interface{} `rethinkdb:"geo_system,omitempty"`
    Unit        interface{} `rethinkdb:"unit,omitempty"`
    Fill        interface{} `rethinkdb:"fill,omitempty"`
}

CircleOpts contains the optional arguments for the Circle term.

type CloseOpts Uses

type CloseOpts struct {
    NoReplyWait bool `rethinkdb:"noreplyWait,omitempty"`
}

CloseOpts allows calls to the Close function to be configured.

type Cluster Uses

type Cluster struct {
    // contains filtered or unexported fields
}

A Cluster represents a connection to a RethinkDB cluster, a cluster is created by the Session and should rarely be created manually.

The cluster keeps track of all nodes in the cluster and if requested can listen for cluster changes and start tracking a new node if one appears. Currently nodes are removed from the pool if they become unhealthy (100 failed queries). This should hopefully soon be replaced by a backoff system.

func NewCluster Uses

func NewCluster(hosts []Host, opts *ConnectOpts) (*Cluster, error)

NewCluster creates a new cluster by connecting to the given hosts.

func (*Cluster) AddSeeds Uses

func (c *Cluster) AddSeeds(hosts []Host)

AddSeeds adds new seed hosts to the cluster.

func (*Cluster) Close Uses

func (c *Cluster) Close(optArgs ...CloseOpts) error

Close closes the cluster

func (*Cluster) Exec Uses

func (c *Cluster) Exec(ctx context.Context, q Query) (err error)

Exec executes a ReQL query using the cluster to connect to the database

func (*Cluster) GetNextNode Uses

func (c *Cluster) GetNextNode() (*Node, hostpool.HostPoolResponse, error)

GetNextNode returns a random node on the cluster

func (*Cluster) GetNodes Uses

func (c *Cluster) GetNodes() []*Node

GetNodes returns a list of all nodes in the cluster

func (*Cluster) IsConnected Uses

func (c *Cluster) IsConnected() bool

IsConnected returns true if cluster has nodes and is not already closed.

func (*Cluster) Query Uses

func (c *Cluster) Query(ctx context.Context, q Query) (cursor *Cursor, err error)

Query executes a ReQL query using the cluster to connect to the database

func (*Cluster) Server Uses

func (c *Cluster) Server() (response ServerResponse, err error)

Server returns the server name and server UUID being used by a connection.

func (*Cluster) SetInitialPoolCap Uses

func (c *Cluster) SetInitialPoolCap(n int)

SetInitialPoolCap sets the initial capacity of the connection pool.

func (*Cluster) SetMaxIdleConns Uses

func (c *Cluster) SetMaxIdleConns(n int)

SetMaxIdleConns sets the maximum number of connections in the idle connection pool.

func (*Cluster) SetMaxOpenConns Uses

func (c *Cluster) SetMaxOpenConns(n int)

SetMaxOpenConns sets the maximum number of open connections to the database.

type ConnectOpts Uses

type ConnectOpts struct {
    // Address holds the address of the server initially used when creating the
    // session. Only used if Addresses is empty
    Address string `rethinkdb:"address,omitempty"`
    // Addresses holds the addresses of the servers initially used when creating
    // the session.
    Addresses []string `rethinkdb:"addresses,omitempty"`
    // Database is the default database name used when executing queries, this
    // value is only used if the query does not contain any DB term
    Database string `rethinkdb:"database,omitempty"`
    // Username holds the username used for authentication, if blank (and the v1
    // handshake protocol is being used) then the admin user is used
    Username string `rethinkdb:"username,omitempty"`
    // Password holds the password used for authentication (only used when using
    // the v1 handshake protocol)
    Password string `rethinkdb:"password,omitempty"`
    // AuthKey is used for authentication when using the v0.4 handshake protocol
    // This field is no deprecated
    AuthKey string `rethinkdb:"authkey,omitempty"`
    // Timeout is the time the driver waits when creating new connections, to
    // configure the timeout used when executing queries use WriteTimeout and
    // ReadTimeout
    Timeout time.Duration `rethinkdb:"timeout,omitempty"`
    // WriteTimeout is the amount of time the driver will wait when sending the
    // query to the server
    WriteTimeout time.Duration `rethinkdb:"write_timeout,omitempty"`
    // ReadTimeout is the amount of time the driver will wait for a response from
    // the server when executing queries.
    ReadTimeout time.Duration `rethinkdb:"read_timeout,omitempty"`
    // KeepAlivePeriod is the keep alive period used by the connection, by default
    // this is 30s. It is not possible to disable keep alive messages
    KeepAlivePeriod time.Duration `rethinkdb:"keep_alive_timeout,omitempty"`
    // TLSConfig holds the TLS configuration and can be used when connecting
    // to a RethinkDB server protected by SSL
    TLSConfig *tls.Config `rethinkdb:"tlsconfig,omitempty"`
    // HandshakeVersion is used to specify which handshake version should be
    // used, this currently defaults to v1 which is used by RethinkDB 2.3 and
    // later. If you are using an older version then you can set the handshake
    // version to 0.4
    HandshakeVersion HandshakeVersion `rethinkdb:"handshake_version,omitempty"`
    // UseJSONNumber indicates whether the cursors running in this session should
    // use json.Number instead of float64 while unmarshaling documents with
    // interface{}. The default is `false`.
    UseJSONNumber bool
    // NumRetries is the number of times a query is retried if a connection
    // error is detected, queries are not retried if RethinkDB returns a
    // runtime error.
    NumRetries int

    // InitialCap is used by the internal connection pool and is used to
    // configure how many connections are created for each host when the
    // session is created. If zero then no connections are created until
    // the first query is executed.
    InitialCap int `rethinkdb:"initial_cap,omitempty"`
    // MaxOpen is used by the internal connection pool and is used to configure
    // the maximum number of connections held in the pool. If all available
    // connections are being used then the driver will open new connections as
    // needed however they will not be returned to the pool. By default the
    // maximum number of connections is 2
    MaxOpen int `rethinkdb:"max_open,omitempty"`

    // DiscoverHosts is used to enable host discovery, when true the driver
    // will attempt to discover any new nodes added to the cluster and then
    // start sending queries to these new nodes.
    DiscoverHosts bool `rethinkdb:"discover_hosts,omitempty"`
    // HostDecayDuration is used by the go-hostpool package to calculate a weighted
    // score when selecting a host. By default a value of 5 minutes is used.
    HostDecayDuration time.Duration

    // UseOpentracing is used to enable creating opentracing-go spans for queries.
    // Each span is created as child of span from the context in `RunOpts`.
    // This span lasts from point the query created to the point when cursor closed.
    UseOpentracing bool

    // Deprecated: This function is no longer used due to changes in the
    // way hosts are selected.
    NodeRefreshInterval time.Duration `rethinkdb:"node_refresh_interval,omitempty"`
    // Deprecated: Use InitialCap instead
    MaxIdle int `rethinkdb:"max_idle,omitempty"`
}

ConnectOpts is used to specify optional arguments when connecting to a cluster.

type Connection Uses

type Connection struct {
    net.Conn
    // contains filtered or unexported fields
}

Connection is a connection to a rethinkdb database. Connection is not thread safe and should only be accessed be a single goroutine

func NewConnection Uses

func NewConnection(address string, opts *ConnectOpts) (*Connection, error)

NewConnection creates a new connection to the database server

func (*Connection) Close Uses

func (c *Connection) Close() error

Close closes the underlying net.Conn

func (*Connection) Query Uses

func (c *Connection) Query(ctx context.Context, q Query) (*Response, *Cursor, error)

Query sends a Query to the database, returning both the raw Response and a Cursor which should be used to view the query's response.

This function is used internally by Run which should be used for most queries.

func (*Connection) Server Uses

func (c *Connection) Server() (ServerResponse, error)

Server returns the server name and server UUID being used by a connection.

type Cursor Uses

type Cursor struct {
    // contains filtered or unexported fields
}

Cursor is the result of a query. Its cursor starts before the first row of the result set. A Cursor is not thread safe and should only be accessed by a single goroutine at any given time. Use Next to advance through the rows:

cursor, err := query.Run(session)
...
defer cursor.Close()

var response interface{}
for cursor.Next(&response) {
    ...
}
err = cursor.Err() // get any error encountered during iteration
...

func (*Cursor) All Uses

func (c *Cursor) All(result interface{}) error

All retrieves all documents from the result set into the provided slice and closes the cursor.

The result argument must necessarily be the address for a slice. The slice may be nil or previously allocated.

Also note that you are able to reuse the same variable multiple times as `All` zeroes the value before scanning in the result. It also attempts to reuse the existing slice without allocating any more space by either resizing or returning a selection of the slice if necessary.

func (*Cursor) Close Uses

func (c *Cursor) Close() error

Close closes the cursor, preventing further enumeration. If the end is encountered, the cursor is closed automatically. Close is idempotent.

func (*Cursor) Err Uses

func (c *Cursor) Err() error

Err returns nil if no errors happened during iteration, or the actual error otherwise.

func (*Cursor) Interface Uses

func (c *Cursor) Interface() (interface{}, error)

Interface retrieves all documents from the result set and returns the data as an interface{} and closes the cursor.

If the query returns multiple documents then a slice will be returned, otherwise a single value will be returned.

func (*Cursor) IsNil Uses

func (c *Cursor) IsNil() bool

IsNil tests if the current row is nil.

func (*Cursor) Listen Uses

func (c *Cursor) Listen(channel interface{})

Listen listens for rows from the database and sends the result onto the given channel. The type that the row is scanned into is determined by the element type of the channel.

Also note that this function returns immediately.

cursor, err := r.Expr([]int{1,2,3}).Run(session)
if err != nil {
    panic(err)
}

ch := make(chan int)
cursor.Listen(ch)
<- ch // 1
<- ch // 2
<- ch // 3

func (*Cursor) Next Uses

func (c *Cursor) Next(dest interface{}) bool

Next retrieves the next document from the result set, blocking if necessary. This method will also automatically retrieve another batch of documents from the server when the current one is exhausted, or before that in background if possible.

Next returns true if a document was successfully unmarshalled onto result, and false at the end of the result set or if an error happened. When Next returns false, the Err method should be called to verify if there was an error during iteration.

Also note that you are able to reuse the same variable multiple times as `Next` zeroes the value before scanning in the result.

func (*Cursor) NextResponse Uses

func (c *Cursor) NextResponse() ([]byte, bool)

NextResponse retrieves the next raw response from the result set, blocking if necessary. Unlike Next the returned response is the raw JSON document returned from the database.

NextResponse returns false (and a nil byte slice) at the end of the result set or if an error happened.

func (*Cursor) One Uses

func (c *Cursor) One(result interface{}) error

One retrieves a single document from the result set into the provided slice and closes the cursor.

Also note that you are able to reuse the same variable multiple times as `One` zeroes the value before scanning in the result.

func (*Cursor) Peek Uses

func (c *Cursor) Peek(dest interface{}) (bool, error)

Peek behaves similarly to Next, retreiving the next document from the result set and blocking if necessary. Peek, however, does not progress the position of the cursor. This can be useful for expressions which can return different types to attempt to decode them into different interfaces.

Like Next, it will also automatically retrieve another batch of documents from the server when the current one is exhausted, or before that in background if possible.

Unlike Next, Peek does not progress the position of the cursor. Peek will return errors from decoding, but they will not be persisted in the cursor and therefore will not be available on cursor.Err(). This can be useful for expressions that can return different types to attempt to decode them into different interfaces.

Peek returns true if a document was successfully unmarshalled onto result, and false at the end of the result set or if an error happened. Peek also returns the error (if any) that occured

func (*Cursor) Profile Uses

func (c *Cursor) Profile() interface{}

Profile returns the information returned from the query profiler.

func (*Cursor) Skip Uses

func (c *Cursor) Skip()

Skip progresses the cursor by one record. It is useful after a successful Peek to avoid duplicate decoding work.

func (*Cursor) Type Uses

func (c *Cursor) Type() string

Type returns the cursor type (by default "Cursor")

type DeleteOpts Uses

type DeleteOpts struct {
    Durability    interface{} `rethinkdb:"durability,omitempty"`
    ReturnChanges interface{} `rethinkdb:"return_changes,omitempty"`
}

DeleteOpts contains the optional arguments for the Delete term

type DistanceOpts Uses

type DistanceOpts struct {
    GeoSystem interface{} `rethinkdb:"geo_system,omitempty"`
    Unit      interface{} `rethinkdb:"unit,omitempty"`
}

DistanceOpts contains the optional arguments for the Distance term.

type DistinctOpts Uses

type DistinctOpts struct {
    Index interface{} `rethinkdb:"index,omitempty"`
}

DistinctOpts contains the optional arguments for the Distinct term

type DuringOpts Uses

type DuringOpts struct {
    LeftBound  interface{} `rethinkdb:"left_bound,omitempty"`
    RightBound interface{} `rethinkdb:"right_bound,omitempty"`
}

DuringOpts contains the optional arguments for the During term

type EqJoinOpts Uses

type EqJoinOpts struct {
    Index   interface{} `rethinkdb:"index,omitempty"`
    Ordered interface{} `rethinkdb:"ordered,omitempty"`
}

EqJoinOpts contains the optional arguments for the EqJoin term.

type ExecOpts Uses

type ExecOpts struct {
    DB             interface{} `rethinkdb:"db,omitempty"`
    Db             interface{} `rethinkdb:"db,omitempty"` // Deprecated
    Profile        interface{} `rethinkdb:"profile,omitempty"`
    Durability     interface{} `rethinkdb:"durability,omitempty"`
    UseOutdated    interface{} `rethinkdb:"use_outdated,omitempty"` // Deprecated
    ArrayLimit     interface{} `rethinkdb:"array_limit,omitempty"`
    TimeFormat     interface{} `rethinkdb:"time_format,omitempty"`
    GroupFormat    interface{} `rethinkdb:"group_format,omitempty"`
    BinaryFormat   interface{} `rethinkdb:"binary_format,omitempty"`
    GeometryFormat interface{} `rethinkdb:"geometry_format,omitempty"`

    MinBatchRows              interface{} `rethinkdb:"min_batch_rows,omitempty"`
    MaxBatchRows              interface{} `rethinkdb:"max_batch_rows,omitempty"`
    MaxBatchBytes             interface{} `rethinkdb:"max_batch_bytes,omitempty"`
    MaxBatchSeconds           interface{} `rethinkdb:"max_batch_seconds,omitempty"`
    FirstBatchScaledownFactor interface{} `rethinkdb:"first_batch_scaledown_factor,omitempty"`

    NoReply interface{} `rethinkdb:"noreply,omitempty"`

    Context context.Context `rethinkdb:"-"`
}

ExecOpts contains the optional arguments for the Exec function and inherits its options from RunOpts, the only difference is the addition of the NoReply field.

When NoReply is true it causes the driver not to wait to receive the result and return immediately.

type FilterOpts Uses

type FilterOpts struct {
    Default interface{} `rethinkdb:"default,omitempty"`
}

FilterOpts contains the optional arguments for the Filter term

type FoldOpts Uses

type FoldOpts struct {
    Emit      interface{} `rethinkdb:"emit,omitempty"`
    FinalEmit interface{} `rethinkdb:"final_emit,omitempty"`
}

FoldOpts contains the optional arguments for the Fold term

type GetAllOpts Uses

type GetAllOpts struct {
    Index interface{} `rethinkdb:"index,omitempty"`
}

GetAllOpts contains the optional arguments for the GetAll term

type GetIntersectingOpts Uses

type GetIntersectingOpts struct {
    Index interface{} `rethinkdb:"index,omitempty"`
}

GetIntersectingOpts contains the optional arguments for the GetIntersecting term.

type GetNearestOpts Uses

type GetNearestOpts struct {
    Index      interface{} `rethinkdb:"index,omitempty"`
    MaxResults interface{} `rethinkdb:"max_results,omitempty"`
    MaxDist    interface{} `rethinkdb:"max_dist,omitempty"`
    Unit       interface{} `rethinkdb:"unit,omitempty"`
    GeoSystem  interface{} `rethinkdb:"geo_system,omitempty"`
}

GetNearestOpts contains the optional arguments for the GetNearest term.

type GroupOpts Uses

type GroupOpts struct {
    Index interface{} `rethinkdb:"index,omitempty"`
    Multi interface{} `rethinkdb:"multi,omitempty"`
}

GroupOpts contains the optional arguments for the Group term

type HTTPOpts Uses

type HTTPOpts struct {
    // General Options
    Timeout      interface{} `rethinkdb:"timeout,omitempty"`
    Reattempts   interface{} `rethinkdb:"reattempts,omitempty"`
    Redirects    interface{} `rethinkdb:"redirect,omitempty"`
    Verify       interface{} `rethinkdb:"verify,omitempty"`
    ResultFormat interface{} `rethinkdb:"result_format,omitempty"`

    // Request Options
    Method interface{} `rethinkdb:"method,omitempty"`
    Auth   interface{} `rethinkdb:"auth,omitempty"`
    Params interface{} `rethinkdb:"params,omitempty"`
    Header interface{} `rethinkdb:"header,omitempty"`
    Data   interface{} `rethinkdb:"data,omitempty"`

    // Pagination
    Page      interface{} `rethinkdb:"page,omitempty"`
    PageLimit interface{} `rethinkdb:"page_limit,omitempty"`
}

HTTPOpts contains the optional arguments for the HTTP term

type HandshakeVersion Uses

type HandshakeVersion int
const (
    HandshakeV1_0 HandshakeVersion = iota
    HandshakeV0_4
)

type Host Uses

type Host struct {
    Name string
    Port int
}

Host name and port of server

func NewHost Uses

func NewHost(name string, port int) Host

NewHost create a new Host

func (Host) String Uses

func (h Host) String() string

Returns host address (name:port)

type ISO8601Opts Uses

type ISO8601Opts struct {
    DefaultTimezone interface{} `rethinkdb:"default_timezone,omitempty"`
}

ISO8601Opts contains the optional arguments for the ISO8601 term

type IndexCreateOpts Uses

type IndexCreateOpts struct {
    Multi interface{} `rethinkdb:"multi,omitempty"`
    Geo   interface{} `rethinkdb:"geo,omitempty"`
}

IndexCreateOpts contains the optional arguments for the IndexCreate term

type IndexRenameOpts Uses

type IndexRenameOpts struct {
    Overwrite interface{} `rethinkdb:"overwrite,omitempty"`
}

IndexRenameOpts contains the optional arguments for the IndexRename term

type InsertOpts Uses

type InsertOpts struct {
    Durability    interface{} `rethinkdb:"durability,omitempty"`
    ReturnChanges interface{} `rethinkdb:"return_changes,omitempty"`
    Conflict      interface{} `rethinkdb:"conflict,omitempty"`
}

InsertOpts contains the optional arguments for the Insert term

type JSOpts Uses

type JSOpts struct {
    Timeout interface{} `rethinkdb:"timeout,omitempty"`
}

JSOpts contains the optional arguments for the JS term

type MaxOpts Uses

type MaxOpts struct {
    Index interface{} `rethinkdb:"index,omitempty"`
}

MaxOpts contains the optional arguments for the Max term

type MinOpts Uses

type MinOpts struct {
    Index interface{} `rethinkdb:"index,omitempty"`
}

MinOpts contains the optional arguments for the Min term

type Mock Uses

type Mock struct {
    ExpectedQueries []*MockQuery
    Queries         []MockQuery
    // contains filtered or unexported fields
}

Mock is used to mock query execution and verify that the expected queries are being executed. Mocks are used by creating an instance using NewMock and then passing this when running your queries instead of a session. For example:

mock := r.NewMock()
mock.On(r.Table("test")).Return([]interface{}{data}, nil)

cursor, err := r.Table("test").Run(mock)

mock.AssertExpectations(t)

func NewMock Uses

func NewMock(opts ...ConnectOpts) *Mock

NewMock creates an instance of Mock, you can optionally pass ConnectOpts to the function, if passed any mocked query will be generated using those options.

func (*Mock) AssertExecuted Uses

func (m *Mock) AssertExecuted(t testingT, expectedQuery *MockQuery) bool

AssertExecuted asserts that the method was executed. It can produce a false result when an argument is a pointer type and the underlying value changed after executing the mocked method.

func (*Mock) AssertExpectations Uses

func (m *Mock) AssertExpectations(t testingT) bool

AssertExpectations asserts that everything specified with On and Return was in fact executed as expected. Queries may have been executed in any order.

func (*Mock) AssertNotExecuted Uses

func (m *Mock) AssertNotExecuted(t testingT, expectedQuery *MockQuery) bool

AssertNotExecuted asserts that the method was not executed. It can produce a false result when an argument is a pointer type and the underlying value changed after executing the mocked method.

func (*Mock) AssertNumberOfExecutions Uses

func (m *Mock) AssertNumberOfExecutions(t testingT, expectedQuery *MockQuery, expectedExecutions int) bool

AssertNumberOfExecutions asserts that the query was executed expectedExecutions times.

func (*Mock) Exec Uses

func (m *Mock) Exec(ctx context.Context, q Query) error

func (*Mock) IsConnected Uses

func (m *Mock) IsConnected() bool

func (*Mock) On Uses

func (m *Mock) On(t Term, opts ...map[string]interface{}) *MockQuery

On starts a description of an expectation of the specified query being executed.

mock.On(r.Table("test"))

func (*Mock) Query Uses

func (m *Mock) Query(ctx context.Context, q Query) (*Cursor, error)

type MockQuery Uses

type MockQuery struct {

    // Holds the query and term
    Query Query

    // Holds the JSON representation of query
    BuiltQuery []byte

    // Holds the response that should be returned when this method is executed.
    Response interface{}

    // Holds the error that should be returned when this method is executed.
    Error error

    // The number of times to return the return arguments when setting
    // expectations. 0 means to always return the value.
    Repeatability int

    // Holds a channel that will be used to block the Return until it either
    // recieves a message or is closed. nil means it returns immediately.
    WaitFor <-chan time.Time
    // contains filtered or unexported fields
}

MockQuery represents a mocked query and is used for setting expectations, as well as recording activity.

func (*MockQuery) After Uses

func (mq *MockQuery) After(d time.Duration) *MockQuery

After sets how long to block until the query returns

mock.On(r.Table("test")).After(time.Second)

func (*MockQuery) On Uses

func (mq *MockQuery) On(t Term) *MockQuery

On chains a new expectation description onto the mocked interface. This allows syntax like.

Mock.
   On(r.Table("test")).Return(result, nil).
   On(r.Table("test2")).Return(nil, errors.New("Some Error"))

func (*MockQuery) Once Uses

func (mq *MockQuery) Once() *MockQuery

Once indicates that that the mock should only return the value once.

mock.On(r.Table("test")).Return(result, nil).Once()

func (*MockQuery) Return Uses

func (mq *MockQuery) Return(response interface{}, err error) *MockQuery

Return specifies the return arguments for the expectation.

mock.On(r.Table("test")).Return(nil, errors.New("failed"))

func (*MockQuery) Times Uses

func (mq *MockQuery) Times(i int) *MockQuery

Times indicates that that the mock should only return the indicated number of times.

mock.On(r.Table("test")).Return(result, nil).Times(5)

func (*MockQuery) Twice Uses

func (mq *MockQuery) Twice() *MockQuery

Twice indicates that that the mock should only return the value twice.

mock.On(r.Table("test")).Return(result, nil).Twice()

func (*MockQuery) WaitUntil Uses

func (mq *MockQuery) WaitUntil(w <-chan time.Time) *MockQuery

WaitUntil sets the channel that will block the mock's return until its closed or a message is received.

mock.On(r.Table("test")).WaitUntil(time.After(time.Second))

type Node Uses

type Node struct {
    ID   string
    Host Host
    // contains filtered or unexported fields
}

Node represents a database server in the cluster

func (*Node) Close Uses

func (n *Node) Close(optArgs ...CloseOpts) error

Close closes the session

func (*Node) Closed Uses

func (n *Node) Closed() bool

Closed returns true if the node is closed

func (*Node) Exec Uses

func (n *Node) Exec(ctx context.Context, q Query) (err error)

Exec executes a ReQL query using this nodes connection pool.

func (*Node) NoReplyWait Uses

func (n *Node) NoReplyWait() error

NoReplyWait ensures that previous queries with the noreply flag have been processed by the server. Note that this guarantee only applies to queries run on the given connection

func (*Node) Query Uses

func (n *Node) Query(ctx context.Context, q Query) (cursor *Cursor, err error)

Query executes a ReQL query using this nodes connection pool.

func (*Node) Server Uses

func (n *Node) Server() (ServerResponse, error)

Server returns the server name and server UUID being used by a connection.

func (*Node) SetInitialPoolCap Uses

func (n *Node) SetInitialPoolCap(idleConns int)

SetInitialPoolCap sets the initial capacity of the connection pool.

func (*Node) SetMaxIdleConns Uses

func (n *Node) SetMaxIdleConns(idleConns int)

SetMaxIdleConns sets the maximum number of connections in the idle connection pool.

func (*Node) SetMaxOpenConns Uses

func (n *Node) SetMaxOpenConns(openConns int)

SetMaxOpenConns sets the maximum number of open connections to the database.

type OptArgs Uses

type OptArgs interface {
    // contains filtered or unexported methods
}

OptArgs is an interface used to represent a terms optional arguments. All optional argument types have a toMap function, the returned map can be encoded and sent as part of the query.

type OrderByOpts Uses

type OrderByOpts struct {
    Index interface{} `rethinkdb:"index,omitempty"`
}

OrderByOpts contains the optional arguments for the OrderBy term

type Pool Uses

type Pool struct {
    // contains filtered or unexported fields
}

A Pool is used to store a pool of connections to a single RethinkDB server

func NewPool Uses

func NewPool(host Host, opts *ConnectOpts) (*Pool, error)

NewPool creates a new connection pool for the given host

func (*Pool) Close Uses

func (p *Pool) Close() error

Close closes the database, releasing any open resources.

It is rare to Close a Pool, as the Pool handle is meant to be long-lived and shared between many goroutines.

func (*Pool) Exec Uses

func (p *Pool) Exec(ctx context.Context, q Query) error

Exec executes a query without waiting for any response.

func (*Pool) Ping Uses

func (p *Pool) Ping() error

Ping verifies a connection to the database is still alive, establishing a connection if necessary.

func (*Pool) Query Uses

func (p *Pool) Query(ctx context.Context, q Query) (*Cursor, error)

Query executes a query and waits for the response

func (*Pool) Server Uses

func (p *Pool) Server() (ServerResponse, error)

Server returns the server name and server UUID being used by a connection.

func (*Pool) SetInitialPoolCap Uses

func (p *Pool) SetInitialPoolCap(n int)

SetInitialPoolCap sets the initial capacity of the connection pool.

Deprecated: This value should only be set when connecting

func (*Pool) SetMaxIdleConns Uses

func (p *Pool) SetMaxIdleConns(n int)

SetMaxIdleConns sets the maximum number of connections in the idle connection pool.

Deprecated: This value should only be set when connecting

func (*Pool) SetMaxOpenConns Uses

func (p *Pool) SetMaxOpenConns(n int)

SetMaxOpenConns sets the maximum number of open connections to the database.

Deprecated: This value should only be set when connecting

type Query Uses

type Query struct {
    Type  p.Query_QueryType
    Token int64
    Term  *Term
    Opts  map[string]interface{}
    // contains filtered or unexported fields
}

A Query represents a query ready to be sent to the database, A Query differs from a Term as it contains both a query type and token. These values are used by the database to determine if the query is continuing a previous request and also allows the driver to identify the response as they can come out of order.

func (*Query) Build Uses

func (q *Query) Build() []interface{}

type QueryExecutor Uses

type QueryExecutor interface {
    IsConnected() bool
    Query(context.Context, Query) (*Cursor, error)
    Exec(context.Context, Query) error
    // contains filtered or unexported methods
}

type RQLAuthError Uses

type RQLAuthError struct{ RQLDriverError }

func (RQLAuthError) Error Uses

func (e RQLAuthError) Error() string

func (RQLAuthError) String Uses

func (e RQLAuthError) String() string

type RQLAvailabilityError Uses

type RQLAvailabilityError struct{ RQLRuntimeError }

func (RQLAvailabilityError) Error Uses

func (e RQLAvailabilityError) Error() string

func (RQLAvailabilityError) String Uses

func (e RQLAvailabilityError) String() string

type RQLClientError Uses

type RQLClientError struct {
    // contains filtered or unexported fields
}

func (RQLClientError) Error Uses

func (e RQLClientError) Error() string

func (RQLClientError) String Uses

func (e RQLClientError) String() string

type RQLCompileError Uses

type RQLCompileError struct {
    // contains filtered or unexported fields
}

func (RQLCompileError) Error Uses

func (e RQLCompileError) Error() string

func (RQLCompileError) String Uses

func (e RQLCompileError) String() string

type RQLConnectionError Uses

type RQLConnectionError struct {
    // contains filtered or unexported fields
}

RQLConnectionError represents an error when communicating with the database server.

func (RQLConnectionError) Error Uses

func (e RQLConnectionError) Error() string

func (RQLConnectionError) String Uses

func (e RQLConnectionError) String() string

type RQLDriverCompileError Uses

type RQLDriverCompileError struct{ RQLCompileError }

func (RQLDriverCompileError) Error Uses

func (e RQLDriverCompileError) Error() string

func (RQLDriverCompileError) String Uses

func (e RQLDriverCompileError) String() string

type RQLDriverError Uses

type RQLDriverError struct {
    // contains filtered or unexported fields
}

RQLDriverError represents an unexpected error with the driver, if this error persists please create an issue.

func (RQLDriverError) Error Uses

func (e RQLDriverError) Error() string

func (RQLDriverError) String Uses

func (e RQLDriverError) String() string

type RQLInternalError Uses

type RQLInternalError struct{ RQLRuntimeError }

func (RQLInternalError) Error Uses

func (e RQLInternalError) Error() string

func (RQLInternalError) String Uses

func (e RQLInternalError) String() string

type RQLNonExistenceError Uses

type RQLNonExistenceError struct{ RQLQueryLogicError }

func (RQLNonExistenceError) Error Uses

func (e RQLNonExistenceError) Error() string

func (RQLNonExistenceError) String Uses

func (e RQLNonExistenceError) String() string

type RQLOpFailedError Uses

type RQLOpFailedError struct{ RQLAvailabilityError }

func (RQLOpFailedError) Error Uses

func (e RQLOpFailedError) Error() string

func (RQLOpFailedError) String Uses

func (e RQLOpFailedError) String() string

type RQLOpIndeterminateError Uses

type RQLOpIndeterminateError struct{ RQLAvailabilityError }

func (RQLOpIndeterminateError) Error Uses

func (e RQLOpIndeterminateError) Error() string

func (RQLOpIndeterminateError) String Uses

func (e RQLOpIndeterminateError) String() string

type RQLQueryLogicError Uses

type RQLQueryLogicError struct{ RQLRuntimeError }

func (RQLQueryLogicError) Error Uses

func (e RQLQueryLogicError) Error() string

func (RQLQueryLogicError) String Uses

func (e RQLQueryLogicError) String() string

type RQLResourceLimitError Uses

type RQLResourceLimitError struct{ RQLRuntimeError }

func (RQLResourceLimitError) Error Uses

func (e RQLResourceLimitError) Error() string

func (RQLResourceLimitError) String Uses

func (e RQLResourceLimitError) String() string

type RQLRuntimeError Uses

type RQLRuntimeError struct {
    // contains filtered or unexported fields
}

func (RQLRuntimeError) Error Uses

func (e RQLRuntimeError) Error() string

func (RQLRuntimeError) String Uses

func (e RQLRuntimeError) String() string

type RQLServerCompileError Uses

type RQLServerCompileError struct{ RQLCompileError }

func (RQLServerCompileError) Error Uses

func (e RQLServerCompileError) Error() string

func (RQLServerCompileError) String Uses

func (e RQLServerCompileError) String() string

type RQLTimeoutError Uses

type RQLTimeoutError struct {
    // contains filtered or unexported fields
}

func (RQLTimeoutError) Error Uses

func (e RQLTimeoutError) Error() string

func (RQLTimeoutError) String Uses

func (e RQLTimeoutError) String() string

type RQLUserError Uses

type RQLUserError struct{ RQLRuntimeError }

func (RQLUserError) Error Uses

func (e RQLUserError) Error() string

func (RQLUserError) String Uses

func (e RQLUserError) String() string

type RandomOpts Uses

type RandomOpts struct {
    Float interface{} `rethinkdb:"float,omitempty"`
}

RandomOpts contains the optional arguments for the Random term.

type ReconfigureOpts Uses

type ReconfigureOpts struct {
    Shards               interface{} `rethinkdb:"shards,omitempty"`
    Replicas             interface{} `rethinkdb:"replicas,omitempty"`
    DryRun               interface{} `rethinkdb:"dry_run,omitempty"`
    EmergencyRepair      interface{} `rethinkdb:"emergency_repair,omitempty"`
    NonVotingReplicaTags interface{} `rethinkdb:"nonvoting_replica_tags,omitempty"`
    PrimaryReplicaTag    interface{} `rethinkdb:"primary_replica_tag,omitempty"`
}

ReconfigureOpts contains the optional arguments for the Reconfigure term.

type ReplaceOpts Uses

type ReplaceOpts struct {
    Durability    interface{} `rethinkdb:"durability,omitempty"`
    ReturnChanges interface{} `rethinkdb:"return_changes,omitempty"`
    NonAtomic     interface{} `rethinkdb:"non_atomic,omitempty"`
}

ReplaceOpts contains the optional arguments for the Replace term

type Response Uses

type Response struct {
    Token     int64
    Type      p.Response_ResponseType   `json:"t"`
    ErrorType p.Response_ErrorType      `json:"e"`
    Notes     []p.Response_ResponseNote `json:"n"`
    Responses []json.RawMessage         `json:"r"`
    Backtrace []interface{}             `json:"b"`
    Profile   interface{}               `json:"p"`
}

Response represents the raw response from a query, most of the time you should instead use a Cursor when reading from the database.

type RunOpts Uses

type RunOpts struct {
    DB             interface{} `rethinkdb:"db,omitempty"`
    Db             interface{} `rethinkdb:"db,omitempty"` // Deprecated
    Profile        interface{} `rethinkdb:"profile,omitempty"`
    Durability     interface{} `rethinkdb:"durability,omitempty"`
    UseOutdated    interface{} `rethinkdb:"use_outdated,omitempty"` // Deprecated
    ArrayLimit     interface{} `rethinkdb:"array_limit,omitempty"`
    TimeFormat     interface{} `rethinkdb:"time_format,omitempty"`
    GroupFormat    interface{} `rethinkdb:"group_format,omitempty"`
    BinaryFormat   interface{} `rethinkdb:"binary_format,omitempty"`
    GeometryFormat interface{} `rethinkdb:"geometry_format,omitempty"`
    ReadMode       interface{} `rethinkdb:"read_mode,omitempty"`

    MinBatchRows              interface{} `rethinkdb:"min_batch_rows,omitempty"`
    MaxBatchRows              interface{} `rethinkdb:"max_batch_rows,omitempty"`
    MaxBatchBytes             interface{} `rethinkdb:"max_batch_bytes,omitempty"`
    MaxBatchSeconds           interface{} `rethinkdb:"max_batch_seconds,omitempty"`
    FirstBatchScaledownFactor interface{} `rethinkdb:"first_batch_scaledown_factor,omitempty"`

    Context context.Context `rethinkdb:"-"`
}

RunOpts contains the optional arguments for the Run function.

type ServerResponse Uses

type ServerResponse struct {
    ID   string `rethinkdb:"id"`
    Name string `rethinkdb:"name"`
}

type Session Uses

type Session struct {
    // contains filtered or unexported fields
}

A Session represents a connection to a RethinkDB cluster and should be used when executing queries.

func Connect Uses

func Connect(opts ConnectOpts) (*Session, error)

Connect creates a new database session. To view the available connection options see ConnectOpts.

By default maxIdle and maxOpen are set to 1: passing values greater than the default (e.g. MaxIdle: "10", MaxOpen: "20") will provide a pool of re-usable connections.

Basic connection example:

session, err := r.Connect(r.ConnectOpts{
	Host: "localhost:28015",
	Database: "test",
	AuthKey:  "14daak1cad13dj",
})

Cluster connection example:

session, err := r.Connect(r.ConnectOpts{
	Hosts: []string{"localhost:28015", "localhost:28016"},
	Database: "test",
	AuthKey:  "14daak1cad13dj",
})

func (*Session) Close Uses

func (s *Session) Close(optArgs ...CloseOpts) error

Close closes the session

func (*Session) Database Uses

func (s *Session) Database() string

Database returns the selected database set by Use

func (*Session) Exec Uses

func (s *Session) Exec(ctx context.Context, q Query) error

Exec executes a ReQL query using the session to connect to the database

func (*Session) IsConnected Uses

func (s *Session) IsConnected() bool

IsConnected returns true if session has a valid connection.

func (*Session) NoReplyWait Uses

func (s *Session) NoReplyWait() error

NoReplyWait ensures that previous queries with the noreply flag have been processed by the server. Note that this guarantee only applies to queries run on the given connection

func (*Session) Query Uses

func (s *Session) Query(ctx context.Context, q Query) (*Cursor, error)

Query executes a ReQL query using the session to connect to the database

func (*Session) Reconnect Uses

func (s *Session) Reconnect(optArgs ...CloseOpts) error

Reconnect closes and re-opens a session.

func (*Session) Server Uses

func (s *Session) Server() (ServerResponse, error)

Server returns the server name and server UUID being used by a connection.

func (*Session) SetHosts Uses

func (s *Session) SetHosts(hosts []Host)

SetHosts resets the hosts used when connecting to the RethinkDB cluster

func (*Session) SetInitialPoolCap Uses

func (s *Session) SetInitialPoolCap(n int)

SetInitialPoolCap sets the initial capacity of the connection pool.

func (*Session) SetMaxIdleConns Uses

func (s *Session) SetMaxIdleConns(n int)

SetMaxIdleConns sets the maximum number of connections in the idle connection pool.

func (*Session) SetMaxOpenConns Uses

func (s *Session) SetMaxOpenConns(n int)

SetMaxOpenConns sets the maximum number of open connections to the database.

func (*Session) Use Uses

func (s *Session) Use(database string)

Use changes the default database used

type SliceOpts Uses

type SliceOpts struct {
    LeftBound  interface{} `rethinkdb:"left_bound,omitempty"`
    RightBound interface{} `rethinkdb:"right_bound,omitempty"`
}

SliceOpts contains the optional arguments for the Slice term

type TableCreateOpts Uses

type TableCreateOpts struct {
    PrimaryKey           interface{} `rethinkdb:"primary_key,omitempty"`
    Durability           interface{} `rethinkdb:"durability,omitempty"`
    Shards               interface{} `rethinkdb:"shards,omitempty"`
    Replicas             interface{} `rethinkdb:"replicas,omitempty"`
    PrimaryReplicaTag    interface{} `rethinkdb:"primary_replica_tag,omitempty"`
    NonVotingReplicaTags interface{} `rethinkdb:"nonvoting_replica_tags,omitempty"`
}

TableCreateOpts contains the optional arguments for the TableCreate term

type TableOpts Uses

type TableOpts struct {
    ReadMode         interface{} `rethinkdb:"read_mode,omitempty"`
    UseOutdated      interface{} `rethinkdb:"use_outdated,omitempty"` // Deprecated
    IdentifierFormat interface{} `rethinkdb:"identifier_format,omitempty"`
}

TableOpts contains the optional arguments for the Table term

type Term Uses

type Term struct {
    // contains filtered or unexported fields
}

A Term represents a query that is being built. Terms consist of a an array of "sub-terms" and a term type. When a Term is a sub-term the first element of the terms data is its parent Term.

When built the term becomes a JSON array, for more information on the format see http://rethinkdb.com/docs/writing-drivers/.

func Add Uses

func Add(args ...interface{}) Term

Add sums two numbers or concatenates two arrays.

func And Uses

func And(args ...interface{}) Term

And performs a logical and on two values.

func Args Uses

func Args(args ...interface{}) Term

Args is a special term used to splice an array of arguments into another term. This is useful when you want to call a variadic term such as GetAll with a set of arguments provided at runtime.

func Asc Uses

func Asc(args ...interface{}) Term

Asc is used by the OrderBy term to specify that the ordering be ascending (the default).

func Avg Uses

func Avg(args ...interface{}) Term

Avg returns the average of all the elements of a sequence. If called with a field name, averages all the values of that field in the sequence, skipping elements of the sequence that lack that field. If called with a function, calls that function on every element of the sequence and averages the results, skipping elements of the sequence where that function returns null or a non-existence error.

func Binary Uses

func Binary(data interface{}) Term

Binary encapsulates binary data within a query.

The type of data binary accepts depends on the client language. In Go, it expects either a byte array/slice or a bytes.Buffer.

Only a limited subset of ReQL commands may be chained after binary:

- coerceTo can coerce binary objects to string types
- count will return the number of bytes in the object
- slice will treat bytes like array indexes (i.e., slice(10,20) will return bytes 10–19)
- typeOf returns PTYPE<BINARY>
- info will return information on a binary object.

func Branch Uses

func Branch(args ...interface{}) Term

Branch evaluates one of two control paths based on the value of an expression. branch is effectively an if renamed due to language constraints.

The type of the result is determined by the type of the branch that gets executed.

func Ceil Uses

func Ceil(args ...interface{}) Term

Ceil rounds the given value up, returning the smallest integer value greater than or equal to the given value (the value’s ceiling).

func Circle Uses

func Circle(point, radius interface{}, optArgs ...CircleOpts) Term

Circle constructs a circular line or polygon. A circle in RethinkDB is a polygon or line approximating a circle of a given radius around a given center, consisting of a specified number of vertices (default 32).

func Contains Uses

func Contains(args ...interface{}) Term

Contains returns whether or not a sequence contains all the specified values, or if functions are provided instead, returns whether or not a sequence contains values matching all the specified functions.

func Count Uses

func Count(args ...interface{}) Term

Count the number of elements in the sequence. With a single argument, count the number of elements equal to it. If the argument is a function, it is equivalent to calling filter before count.

func DB Uses

func DB(args ...interface{}) Term

DB references a database.

func DBCreate Uses

func DBCreate(args ...interface{}) Term

DBCreate creates a database. A RethinkDB database is a collection of tables, similar to relational databases.

Note: that you can only use alphanumeric characters and underscores for the database name.

func DBDrop Uses

func DBDrop(args ...interface{}) Term

DBDrop drops a database. The database, all its tables, and corresponding data will be deleted.

func DBList Uses

func DBList(args ...interface{}) Term

DBList lists all database names in the system.

func Desc Uses

func Desc(args ...interface{}) Term

Desc is used by the OrderBy term to specify the ordering to be descending.

func Distance Uses

func Distance(point1, point2 interface{}, optArgs ...DistanceOpts) Term

Distance calculates the Haversine distance between two points. At least one of the geometry objects specified must be a point.

func Distinct Uses

func Distinct(arg interface{}, optArgs ...DistinctOpts) Term

Distinct removes duplicate elements from the sequence.

func Div Uses

func Div(args ...interface{}) Term

Div divides two numbers.

func Do Uses

func Do(args ...interface{}) Term

Do evaluates the expr in the context of one or more value bindings. The type of the result is the type of the value returned from expr.

func EpochTime Uses

func EpochTime(args ...interface{}) Term

EpochTime returns a time object based on seconds since epoch

func Eq Uses

func Eq(args ...interface{}) Term

Eq returns true if two values are equal.

func Error Uses

func Error(args ...interface{}) Term

Error throws a runtime error. If called with no arguments inside the second argument to `default`, re-throw the current error.

func Expr Uses

func Expr(val interface{}) Term

Expr converts any value to an expression and is also used by many other terms such as Insert and Update. This function can convert the following basic Go types (bool, int, uint, string, float) and even pointers, maps and structs.

When evaluating structs they are encoded into a map before being sent to the server. Each exported field is added to the map unless

- the field's tag is "-", or
- the field is empty and its tag specifies the "omitempty" option.

Each fields default name in the map is the field name but can be specified in the struct field's tag value. The "rethinkdb" key in the struct field's tag value is the key name, followed by an optional comma and options. Examples:

// Field is ignored by this package.
Field int `rethinkdb:"-"`
// Field appears as key "myName".
Field int `rethinkdb:"myName"`
// Field appears as key "myName" and
// the field is omitted from the object if its value is empty,
// as defined above.
Field int `rethinkdb:"myName,omitempty"`
// Field appears as key "Field" (the default), but
// the field is skipped if empty.
// Note the leading comma.
Field int `rethinkdb:",omitempty"`

func Floor Uses

func Floor(args ...interface{}) Term

Floor rounds the given value down, returning the largest integer value less than or equal to the given value (the value’s floor).

func Ge Uses

func Ge(args ...interface{}) Term

Ge returns true if the first value is greater than or equal to the second.

func GeoJSON Uses

func GeoJSON(args ...interface{}) Term

GeoJSON converts a GeoJSON object to a ReQL geometry object.

func Group Uses

func Group(fieldOrFunctions ...interface{}) Term

Group takes a stream and partitions it into multiple groups based on the fields or functions provided. Commands chained after group will be called on each of these grouped sub-streams, producing grouped data.

func GroupByIndex Uses

func GroupByIndex(index interface{}, fieldOrFunctions ...interface{}) Term

GroupByIndex takes a stream and partitions it into multiple groups based on the fields or functions provided. Commands chained after group will be called on each of these grouped sub-streams, producing grouped data.

func Gt Uses

func Gt(args ...interface{}) Term

Gt returns true if the first value is greater than the second.

func HTTP Uses

func HTTP(url interface{}, optArgs ...HTTPOpts) Term

HTTP retrieves data from the specified URL over HTTP. The return type depends on the resultFormat option, which checks the Content-Type of the response by default.

func ISO8601 Uses

func ISO8601(date interface{}, optArgs ...ISO8601Opts) Term

ISO8601 returns a time object based on an ISO8601 formatted date-time string

func JS Uses

func JS(jssrc interface{}, optArgs ...JSOpts) Term

JS creates a JavaScript expression which is evaluated by the database when running the query.

func JSON Uses

func JSON(args ...interface{}) Term

JSON parses a JSON string on the server.

func Le Uses

func Le(args ...interface{}) Term

Le returns true if the first value is less than or equal to the second.

func Line Uses

func Line(args ...interface{}) Term

Line constructs a geometry object of type Line. The line can be specified in one of two ways:

- Two or more two-item arrays, specifying longitude and latitude numbers of
 the line's vertices;
- Two or more Point objects specifying the line's vertices.

func Literal Uses

func Literal(args ...interface{}) Term

Literal replaces an object in a field instead of merging it with an existing object in a merge or update operation.

func Lt Uses

func Lt(args ...interface{}) Term

Lt returns true if the first value is less than the second.

func Map Uses

func Map(args ...interface{}) Term

Map transform each element of the sequence by applying the given mapping function. It takes two arguments, a sequence and a function of type `func (r.Term) interface{}`.

For example this query doubles each element in an array:

r.Map([]int{1,3,6}, func (row r.Term) interface{} {
    return row.Mul(2)
})

func Max Uses

func Max(args ...interface{}) Term

Max finds the maximum of a sequence. If called with a field name, finds the element of that sequence with the largest value in that field. If called with a function, calls that function on every element of the sequence and returns the element which produced the largest value, ignoring any elements where the function returns null or produces a non-existence error.

func MaxIndex Uses

func MaxIndex(index interface{}, args ...interface{}) Term

MaxIndex finds the maximum of a sequence. If called with a field name, finds the element of that sequence with the largest value in that field. If called with a function, calls that function on every element of the sequence and returns the element which produced the largest value, ignoring any elements where the function returns null or produces a non-existence error.

func Min Uses

func Min(args ...interface{}) Term

Min finds the minimum of a sequence. If called with a field name, finds the element of that sequence with the smallest value in that field. If called with a function, calls that function on every element of the sequence and returns the element which produced the smallest value, ignoring any elements where the function returns null or produces a non-existence error.

func MinIndex Uses

func MinIndex(index interface{}, args ...interface{}) Term

MinIndex finds the minimum of a sequence. If called with a field name, finds the element of that sequence with the smallest value in that field. If called with a function, calls that function on every element of the sequence and returns the element which produced the smallest value, ignoring any elements where the function returns null or produces a non-existence error.

func MockAnything Uses

func MockAnything() Term

MockAnything can be used in place of any term, this is useful when you want mock similar queries or queries that you don't quite know the exact structure of.

func Mod Uses

func Mod(args ...interface{}) Term

Mod divides two numbers and returns the remainder.

func Mul Uses

func Mul(args ...interface{}) Term

Mul multiplies two numbers.

func MultiGroup Uses

func MultiGroup(fieldOrFunctions ...interface{}) Term

MultiGroup takes a stream and partitions it into multiple groups based on the fields or functions provided. Commands chained after group will be called on each of these grouped sub-streams, producing grouped data.

Unlike Group single documents can be assigned to multiple groups, similar to the behavior of multi-indexes. When the grouping value is an array, documents will be placed in each group that corresponds to the elements of the array. If the array is empty the row will be ignored.

func MultiGroupByIndex Uses

func MultiGroupByIndex(index interface{}, fieldOrFunctions ...interface{}) Term

MultiGroupByIndex takes a stream and partitions it into multiple groups based on the fields or functions provided. Commands chained after group will be called on each of these grouped sub-streams, producing grouped data.

Unlike Group single documents can be assigned to multiple groups, similar to the behavior of multi-indexes. When the grouping value is an array, documents will be placed in each group that corresponds to the elements of the array. If the array is empty the row will be ignored.

func Ne Uses

func Ne(args ...interface{}) Term

Ne returns true if two values are not equal.

func Not Uses

func Not(args ...interface{}) Term

Not performs a logical not on a value.

func Now Uses

func Now(args ...interface{}) Term

Now returns a time object representing the current time in UTC

func Object Uses

func Object(args ...interface{}) Term

Object creates an object from a list of key-value pairs, where the keys must be strings.

func Or Uses

func Or(args ...interface{}) Term

Or performs a logical or on two values.

func Point Uses

func Point(lon, lat interface{}) Term

Point constructs a geometry object of type Point. The point is specified by two floating point numbers, the longitude (−180 to 180) and latitude (−90 to 90) of the point on a perfect sphere.

func Polygon Uses

func Polygon(args ...interface{}) Term

Polygon constructs a geometry object of type Polygon. The Polygon can be specified in one of two ways:

- Three or more two-item arrays, specifying longitude and latitude numbers of the polygon's vertices;
- Three or more Point objects specifying the polygon's vertices.

func Random Uses

func Random(args ...interface{}) Term

Random generates a random number between given (or implied) bounds. Random takes zero, one or two arguments.

With zero arguments, the result will be a floating-point number in the range [0,1).

With one argument x, the result will be in the range [0,x), and will be an integer unless the Float option is set to true. Specifying a floating point number without the Float option will raise an error.

With two arguments x and y, the result will be in the range [x,y), and will be an integer unless the Float option is set to true. If x and y are equal an error will occur, unless the floating-point option has been specified, in which case x will be returned. Specifying a floating point number without the float option will raise an error.

Note: Any integer responses can be be coerced to floating-points, when unmarshaling to a Go floating-point type. The last argument given will always be the ‘open’ side of the range, but when generating a floating-point number, the ‘open’ side may be less than the ‘closed’ side.

func Range Uses

func Range(args ...interface{}) Term

Range generates a stream of sequential integers in a specified range. It accepts 0, 1, or 2 arguments, all of which should be numbers.

func RawQuery Uses

func RawQuery(q []byte) Term

RawQuery creates a new query from a JSON string, this bypasses any encoding done by RethinkDB-go. The query should not contain the query type or any options as this should be handled using the normal driver API.

THis query will only work if this is the only term in the query.

func Round Uses

func Round(args ...interface{}) Term

Round causes the input number to be rounded the given value to the nearest whole integer.

func Sub Uses

func Sub(args ...interface{}) Term

Sub subtracts two numbers.

func Sum Uses

func Sum(args ...interface{}) Term

Sum returns the sum of all the elements of a sequence. If called with a field name, sums all the values of that field in the sequence, skipping elements of the sequence that lack that field. If called with a function, calls that function on every element of the sequence and sums the results, skipping elements of the sequence where that function returns null or a non-existence error.

func Table Uses

func Table(name interface{}, optArgs ...TableOpts) Term

Table selects all documents in a table. This command can be chained with other commands to do further processing on the data.

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

func TableCreate Uses

func TableCreate(name interface{}, optArgs ...TableCreateOpts) Term

TableCreate creates a table. A RethinkDB table is a collection of JSON documents.

Note: Only alphanumeric characters and underscores are valid for the table name.

func TableDrop Uses

func TableDrop(args ...interface{}) Term

TableDrop deletes a table. The table and all its data will be deleted.

func TableList Uses

func TableList(args ...interface{}) Term

TableList lists all table names in a database.

func Time Uses

func Time(args ...interface{}) Term

Time creates a time object for a specific time

func TypeOf Uses

func TypeOf(args ...interface{}) Term

TypeOf gets the type of a value.

func UUID Uses

func UUID(args ...interface{}) Term

UUID returns a UUID (universally unique identifier), a string that can be used as a unique ID. If a string is passed to uuid as an argument, the UUID will be deterministic, derived from the string’s SHA-1 hash.

func Union Uses

func Union(args ...interface{}) Term

Union concatenates two sequences.

func UnionWithOpts Uses

func UnionWithOpts(optArgs UnionOpts, args ...interface{}) Term

UnionWithOpts like Union concatenates two sequences however allows for optional arguments to be passed.

func Wait Uses

func Wait(optArgs ...WaitOpts) Term

Wait for a table or all the tables in a database to be ready. A table may be temporarily unavailable after creation, rebalancing or reconfiguring. The wait command blocks until the given table (or database) is fully up to date.

Deprecated: This function is not supported by RethinkDB 2.3 and above.

func (Term) Add Uses

func (t Term) Add(args ...interface{}) Term

Add sums two numbers or concatenates two arrays.

func (Term) And Uses

func (t Term) And(args ...interface{}) Term

And performs a logical and on two values.

func (Term) Append Uses

func (t Term) Append(args ...interface{}) Term

Append appends a value to an array.

func (Term) AtIndex Uses

func (t Term) AtIndex(args ...interface{}) Term

AtIndex gets a single field from an object or the nth element from a sequence.

func (Term) Avg Uses

func (t Term) Avg(args ...interface{}) Term

Avg returns the average of all the elements of a sequence. If called with a field name, averages all the values of that field in the sequence, skipping elements of the sequence that lack that field. If called with a function, calls that function on every element of the sequence and averages the results, skipping elements of the sequence where that function returns null or a non-existence error.

func (Term) Between Uses

func (t Term) Between(lowerKey, upperKey interface{}, optArgs ...BetweenOpts) Term

Between gets all documents between two keys. Accepts three optional arguments: index, leftBound, and rightBound. If index is set to the name of a secondary index, between will return all documents where that index’s value is in the specified range (it uses the primary key by default). leftBound or rightBound may be set to open or closed to indicate whether or not to include that endpoint of the range (by default, leftBound is closed and rightBound is open).

You may also use the special constants r.minval and r.maxval for boundaries, which represent “less than any index key” and “more than any index key” respectively. For instance, if you use r.minval as the lower key, then between will return all documents whose primary keys (or indexes) are less than the specified upper key.

func (Term) Branch Uses

func (t Term) Branch(args ...interface{}) Term

Branch evaluates one of two control paths based on the value of an expression. branch is effectively an if renamed due to language constraints.

The type of the result is determined by the type of the branch that gets executed.

func (Term) Build Uses

func (t Term) Build() (interface{}, error)

build takes the query tree and prepares it to be sent as a JSON expression

func (Term) Ceil Uses

func (t Term) Ceil(args ...interface{}) Term

Ceil rounds the given value up, returning the smallest integer value greater than or equal to the given value (the value’s ceiling).

func (Term) ChangeAt Uses

func (t Term) ChangeAt(args ...interface{}) Term

ChangeAt changes a value in an array at a given index. Returns the modified array.

func (Term) Changes Uses

func (t Term) Changes(optArgs ...ChangesOpts) Term

Changes returns an infinite stream of objects representing changes to a query.

func (Term) CoerceTo Uses

func (t Term) CoerceTo(args ...interface{}) Term

CoerceTo converts a value of one type into another.

You can convert: a selection, sequence, or object into an ARRAY, an array of pairs into an OBJECT, and any DATUM into a STRING.

func (Term) ConcatMap Uses

func (t Term) ConcatMap(args ...interface{}) Term

ConcatMap concatenates one or more elements into a single sequence using a mapping function. ConcatMap works in a similar fashion to Map, applying the given function to each element in a sequence, but it will always return a single sequence.

func (Term) Config Uses

func (t Term) Config() Term

Config can be used to read and/or update the configurations for individual tables or databases.

func (Term) Contains Uses

func (t Term) Contains(args ...interface{}) Term

Contains returns whether or not a sequence contains all the specified values, or if functions are provided instead, returns whether or not a sequence contains values matching all the specified functions.

func (Term) Count Uses

func (t Term) Count(args ...interface{}) Term

Count the number of elements in the sequence. With a single argument, count the number of elements equal to it. If the argument is a function, it is equivalent to calling filter before count.

func (Term) Date Uses

func (t Term) Date(args ...interface{}) Term

Date returns a new time object only based on the day, month and year (ie. the same day at 00:00).

func (Term) Day Uses

func (t Term) Day(args ...interface{}) Term

Day return the day of a time object as a number between 1 and 31.

func (Term) DayOfWeek Uses

func (t Term) DayOfWeek(args ...interface{}) Term

DayOfWeek returns the day of week of a time object as a number between 1 and 7 (following ISO 8601 standard). For your convenience, the terms r.Monday(), r.Tuesday() etc. are defined and map to the appropriate integer.

func (Term) DayOfYear Uses

func (t Term) DayOfYear(args ...interface{}) Term

DayOfYear returns the day of the year of a time object as a number between 1 and 366 (following ISO 8601 standard).

func (Term) Default Uses

func (t Term) Default(args ...interface{}) Term

Default handles non-existence errors. Tries to evaluate and return its first argument. If an error related to the absence of a value is thrown in the process, or if its first argument returns null, returns its second argument. (Alternatively, the second argument may be a function which will be called with either the text of the non-existence error or null.)

func (Term) Delete Uses

func (t Term) Delete(optArgs ...DeleteOpts) Term

Delete one or more documents from a table.

func (Term) DeleteAt Uses

func (t Term) DeleteAt(args ...interface{}) Term

DeleteAt removes an element from an array at a given index. Returns the modified array.

func (Term) Difference Uses

func (t Term) Difference(args ...interface{}) Term

Difference removes the elements of one array from another array.

func (Term) Distance Uses

func (t Term) Distance(point interface{}, optArgs ...DistanceOpts) Term

Distance calculates the Haversine distance between two points. At least one of the geometry objects specified must be a point.

func (Term) Distinct Uses

func (t Term) Distinct(optArgs ...DistinctOpts) Term

Distinct removes duplicate elements from the sequence.

func (Term) Div Uses

func (t Term) Div(args ...interface{}) Term

Div divides two numbers.

func (Term) Do Uses

func (t Term) Do(args ...interface{}) Term

Do evaluates the expr in the context of one or more value bindings. The type of the result is the type of the value returned from expr.

func (Term) Downcase Uses

func (t Term) Downcase(args ...interface{}) Term

Downcase lower-cases a string.

func (Term) During Uses

func (t Term) During(startTime, endTime interface{}, optArgs ...DuringOpts) Term

During returns true if a time is between two other times (by default, inclusive for the start, exclusive for the end).

func (Term) Eq Uses

func (t Term) Eq(args ...interface{}) Term

Eq returns true if two values are equal.

func (Term) EqJoin Uses

func (t Term) EqJoin(left, right interface{}, optArgs ...EqJoinOpts) Term

EqJoin is an efficient join that looks up elements in the right table by primary key.

Optional arguments: "index" (string - name of the index to use in right table instead of the primary key)

func (Term) Exec Uses

func (t Term) Exec(s QueryExecutor, optArgs ...ExecOpts) error

Exec runs the query but does not return the result. Exec will still wait for the response to be received unless the NoReply field is true.

err := r.DB("database").Table("table").Insert(doc).Exec(sess, r.ExecOpts{
	NoReply: true,
})

func (Term) Field Uses

func (t Term) Field(args ...interface{}) Term

Field gets a single field from an object. If called on a sequence, gets that field from every object in the sequence, skipping objects that lack it.

func (Term) Fill Uses

func (t Term) Fill() Term

Fill converts a Line object into a Polygon object. If the last point does not specify the same coordinates as the first point, polygon will close the polygon by connecting them

func (Term) Filter Uses

func (t Term) Filter(f interface{}, optArgs ...FilterOpts) Term

Filter gets all the documents for which the given predicate is true.

Filter can be called on a sequence, selection, or a field containing an array of elements. The return type is the same as the type on which the function was called on. The body of every filter is wrapped in an implicit `.default(false)`, and the default value can be changed by passing the optional argument `default`. Setting this optional argument to `r.error()` will cause any non-existence errors to abort the filter.

func (Term) Floor Uses

func (t Term) Floor(args ...interface{}) Term

Floor rounds the given value down, returning the largest integer value less than or equal to the given value (the value’s floor).

func (Term) Fold Uses

func (t Term) Fold(base, fn interface{}, optArgs ...FoldOpts) Term

Fold applies a function to a sequence in order, maintaining state via an accumulator. The Fold command returns either a single value or a new sequence.

In its first form, Fold operates like Reduce, returning a value by applying a combining function to each element in a sequence, passing the current element and the previous reduction result to the function. However, Fold has the following differences from Reduce:

- it is guaranteed to proceed through the sequence from first element to last.
- it passes an initial base value to the function with the first element in
  place of the previous reduction result.

In its second form, Fold operates like ConcatMap, returning a new sequence rather than a single value. When an emit function is provided, Fold will:

- proceed through the sequence in order and take an initial base value, as above.
- for each element in the sequence, call both the combining function and a
  separate emitting function with the current element and previous reduction result.
- optionally pass the result of the combining function to the emitting function.

If provided, the emitting function must return a list.

func (Term) ForEach Uses

func (t Term) ForEach(args ...interface{}) Term

ForEach loops over a sequence, evaluating the given write query for each element.

It takes one argument of type `func (r.Term) interface{}`, for example clones a table:

r.Table("table").ForEach(func (row r.Term) interface{} {
    return r.Table("new_table").Insert(row)
})

func (Term) Ge Uses

func (t Term) Ge(args ...interface{}) Term

Ge returns true if the first value is greater than or equal to the second.

func (Term) Get Uses

func (t Term) Get(args ...interface{}) Term

Get gets a document by primary key. If nothing was found, RethinkDB will return a nil value.

func (Term) GetAll Uses

func (t Term) GetAll(keys ...interface{}) Term

GetAll gets all documents where the given value matches the value of the primary index. Multiple values can be passed this function if you want to select multiple documents. If the documents you are fetching have composite keys then each argument should be a slice. For more information see the examples.

func (Term) GetAllByIndex Uses

func (t Term) GetAllByIndex(index interface{}, keys ...interface{}) Term

GetAllByIndex gets all documents where the given value matches the value of the requested index.

func (Term) GetIntersecting Uses

func (t Term) GetIntersecting(args interface{}, optArgs ...GetIntersectingOpts) Term

GetIntersecting gets all documents where the given geometry object intersects the geometry object of the requested geospatial index.

func (Term) GetNearest Uses

func (t Term) GetNearest(point interface{}, optArgs ...GetNearestOpts) Term

GetNearest gets all documents where the specified geospatial index is within a certain distance of the specified point (default 100 kilometers).

func (Term) Grant Uses

func (t Term) Grant(args ...interface{}) Term

Grant modifies access permissions for a user account, globally or on a per-database or per-table basis.

func (Term) Group Uses

func (t Term) Group(fieldOrFunctions ...interface{}) Term

Group takes a stream and partitions it into multiple groups based on the fields or functions provided. Commands chained after group will be called on each of these grouped sub-streams, producing grouped data.

func (Term) GroupByIndex Uses

func (t Term) GroupByIndex(index interface{}, fieldOrFunctions ...interface{}) Term

GroupByIndex takes a stream and partitions it into multiple groups based on the fields or functions provided. Commands chained after group will be called on each of these grouped sub-streams, producing grouped data.

func (Term) Gt Uses

func (t Term) Gt(args ...interface{}) Term

Gt returns true if the first value is greater than the second.

func (Term) HasFields Uses

func (t Term) HasFields(args ...interface{}) Term

HasFields tests if an object has all of the specified fields. An object has a field if it has the specified key and that key maps to a non-null value. For instance,

the object `{'a':1,'b':2,'c':null}` has the fields `a` and `b`.

func (Term) Hours Uses

func (t Term) Hours(args ...interface{}) Term

Hours returns the hour in a time object as a number between 0 and 23.

func (Term) InTimezone Uses

func (t Term) InTimezone(args ...interface{}) Term

InTimezone returns a new time object with a different time zone. While the time stays the same, the results returned by methods such as hours() will change since they take the timezone into account. The timezone argument has to be of the ISO 8601 format.

func (Term) Includes Uses

func (t Term) Includes(args ...interface{}) Term

Includes tests whether a geometry object is completely contained within another. When applied to a sequence of geometry objects, includes acts as a filter, returning a sequence of objects from the sequence that include the argument.

func (Term) IndexCreate Uses

func (t Term) IndexCreate(name interface{}, optArgs ...IndexCreateOpts) Term

IndexCreate creates a new secondary index on a table. Secondary indexes improve the speed of many read queries at the slight cost of increased storage space and decreased write performance.

IndexCreate supports the creation of the following types of indexes, to create indexes using arbitrary expressions use IndexCreateFunc.

- Simple indexes based on the value of a single field.
- Geospatial indexes based on indexes of geometry objects, created when the
  geo optional argument is true.

func (Term) IndexCreateFunc Uses

func (t Term) IndexCreateFunc(name, indexFunction interface{}, optArgs ...IndexCreateOpts) Term

IndexCreateFunc creates a new secondary index on a table. Secondary indexes improve the speed of many read queries at the slight cost of increased storage space and decreased write performance. The function takes a index name and RQL term as the index value , the term can be an anonymous function or a binary representation obtained from the function field of indexStatus.

It supports the creation of the following types of indexes.

- Simple indexes based on the value of a single field where the index has a
  different name to the field.
- Compound indexes based on multiple fields.
- Multi indexes based on arrays of values, created when the multi optional argument is true.

func (Term) IndexDrop Uses

func (t Term) IndexDrop(args ...interface{}) Term

IndexDrop deletes a previously created secondary index of a table.

func (Term) IndexList Uses

func (t Term) IndexList(args ...interface{}) Term

IndexList lists all the secondary indexes of a table.

func (Term) IndexRename Uses

func (t Term) IndexRename(oldName, newName interface{}, optArgs ...IndexRenameOpts) Term

IndexRename renames an existing secondary index on a table.

func (Term) IndexStatus Uses

func (t Term) IndexStatus(args ...interface{}) Term

IndexStatus gets the status of the specified indexes on this table, or the status of all indexes on this table if no indexes are specified.

func (Term) IndexWait Uses

func (t Term) IndexWait(args ...interface{}) Term

IndexWait waits for the specified indexes on this table to be ready, or for all indexes on this table to be ready if no indexes are specified.

func (Term) Info Uses

func (t Term) Info(args ...interface{}) Term

Info gets information about a RQL value.

func (Term) InnerJoin Uses

func (t Term) InnerJoin(args ...interface{}) Term

InnerJoin returns the inner product of two sequences (e.g. a table, a filter result) filtered by the predicate. The query compares each row of the left sequence with each row of the right sequence to find all pairs of rows which satisfy the predicate. When the predicate is satisfied, each matched pair of rows of both sequences are combined into a result row.

func (Term) Insert Uses

func (t Term) Insert(arg interface{}, optArgs ...InsertOpts) Term

Insert documents into a table. Accepts a single document or an array of documents.

func (Term) InsertAt Uses

func (t Term) InsertAt(args ...interface{}) Term

InsertAt inserts a value in to an array at a given index. Returns the modified array.

func (Term) Intersects Uses

func (t Term) Intersects(args ...interface{}) Term

Intersects tests whether two geometry objects intersect with one another. When applied to a sequence of geometry objects, intersects acts as a filter, returning a sequence of objects from the sequence that intersect with the argument.

func (Term) IsEmpty Uses

func (t Term) IsEmpty(args ...interface{}) Term

IsEmpty tests if a sequence is empty.

func (Term) Keys Uses

func (t Term) Keys(args ...interface{}) Term

Keys returns an array containing all of the object's keys.

func (Term) Le Uses

func (t Term) Le(args ...interface{}) Term

Le returns true if the first value is less than or equal to the second.

func (Term) Limit Uses

func (t Term) Limit(args ...interface{}) Term

Limit ends the sequence after the given number of elements.

func (Term) Lt Uses

func (t Term) Lt(args ...interface{}) Term

Lt returns true if the first value is less than the second.

func (Term) Map Uses

func (t Term) Map(args ...interface{}) Term

Map transforms each element of the sequence by applying the given mapping function. It takes one argument of type `func (r.Term) interface{}`.

For example this query doubles each element in an array:

r.Expr([]int{1,3,6}).Map(func (row r.Term) interface{} {
    return row.Mul(2)
})

func (Term) Match Uses

func (t Term) Match(args ...interface{}) Term

Match matches against a regular expression. If no match is found, returns null. If there is a match then an object with the following fields is returned:

str: The matched string
start: The matched string’s start
end: The matched string’s end
groups: The capture groups defined with parentheses

Accepts RE2 syntax (https://code.google.com/p/re2/wiki/Syntax). You can enable case-insensitive matching by prefixing the regular expression with (?i). See the linked RE2 documentation for more flags.

The match command does not support backreferences.

func (Term) Max Uses

func (t Term) Max(args ...interface{}) Term

Max finds the maximum of a sequence. If called with a field name, finds the element of that sequence with the largest value in that field. If called with a function, calls that function on every element of the sequence and returns the element which produced the largest value, ignoring any elements where the function returns null or produces a non-existence error.

func (Term) MaxIndex Uses

func (t Term) MaxIndex(index interface{}, args ...interface{}) Term

MaxIndex finds the maximum of a sequence. If called with a field name, finds the element of that sequence with the largest value in that field. If called with a function, calls that function on every element of the sequence and returns the element which produced the largest value, ignoring any elements where the function returns null or produces a non-existence error.

func (Term) Merge Uses

func (t Term) Merge(args ...interface{}) Term

Merge merges two objects together to construct a new object with properties from both. Gives preference to attributes from other when there is a conflict.

func (Term) Min Uses

func (t Term) Min(args ...interface{}) Term

Min finds the minimum of a sequence. If called with a field name, finds the element of that sequence with the smallest value in that field. If called with a function, calls that function on every element of the sequence and returns the element which produced the smallest value, ignoring any elements where the function returns null or produces a non-existence error.

func (Term) MinIndex Uses

func (t Term) MinIndex(index interface{}, args ...interface{}) Term

MinIndex finds the minimum of a sequence. If called with a field name, finds the element of that sequence with the smallest value in that field. If called with a function, calls that function on every element of the sequence and returns the element which produced the smallest value, ignoring any elements where the function returns null or produces a non-existence error.

func (Term) Minutes Uses

func (t Term) Minutes(args ...interface{}) Term

Minutes returns the minute in a time object as a number between 0 and 59.

func (Term) MockAnything Uses

func (t Term) MockAnything() Term

func (Term) Mod Uses

func (t Term) Mod(args ...interface{}) Term

Mod divides two numbers and returns the remainder.

func (Term) Month Uses

func (t Term) Month(args ...interface{}) Term

Month returns the month of a time object as a number between 1 and 12. For your convenience, the terms r.January(), r.February() etc. are defined and map to the appropriate integer.

func (Term) Mul Uses

func (t Term) Mul(args ...interface{}) Term

Mul multiplies two numbers.

func (Term) MultiGroup Uses

func (t Term) MultiGroup(fieldOrFunctions ...interface{}) Term

MultiGroup takes a stream and partitions it into multiple groups based on the fields or functions provided. Commands chained after group will be called on each of these grouped sub-streams, producing grouped data.

Unlike Group single documents can be assigned to multiple groups, similar to the behavior of multi-indexes. When the grouping value is an array, documents will be placed in each group that corresponds to the elements of the array. If the array is empty the row will be ignored.

func (Term) MultiGroupByIndex Uses

func (t Term) MultiGroupByIndex(index interface{}, fieldOrFunctions ...interface{}) Term

MultiGroupByIndex takes a stream and partitions it into multiple groups based on the fields or functions provided. Commands chained after group will be called on each of these grouped sub-streams, producing grouped data.

Unlike Group single documents can be assigned to multiple groups, similar to the behavior of multi-indexes. When the grouping value is an array, documents will be placed in each group that corresponds to the elements of the array. If the array is empty the row will be ignored.

func (Term) Ne Uses

func (t Term) Ne(args ...interface{}) Term

Ne returns true if two values are not equal.

func (Term) Not Uses

func (t Term) Not(args ...interface{}) Term

Not performs a logical not on a value.

func (Term) Nth Uses

func (t Term) Nth(args ...interface{}) Term

Nth gets the nth element from a sequence.

func (Term) OffsetsOf Uses

func (t Term) OffsetsOf(args ...interface{}) Term

OffsetsOf gets the indexes of an element in a sequence. If the argument is a predicate, get the indexes of all elements matching it.

func (Term) OptArgs Uses

func (t Term) OptArgs(args interface{}) Term

func (Term) Or Uses

func (t Term) Or(args ...interface{}) Term

Or performs a logical or on two values.

func (Term) OrderBy Uses

func (t Term) OrderBy(args ...interface{}) Term

OrderBy sorts the sequence by document values of the given key(s). To specify the ordering, wrap the attribute with either r.Asc or r.Desc (defaults to ascending).

Sorting without an index requires the server to hold the sequence in memory, and is limited to 100,000 documents (or the setting of the ArrayLimit option for run). Sorting with an index can be done on arbitrarily large tables, or after a between command using the same index.

func (Term) OuterJoin Uses

func (t Term) OuterJoin(args ...interface{}) Term

OuterJoin computes a left outer join by retaining each row in the left table even if no match was found in the right table.

func (Term) Pluck Uses

func (t Term) Pluck(args ...interface{}) Term

Pluck plucks out one or more attributes from either an object or a sequence of objects (projection).

func (Term) PolygonSub Uses

func (t Term) PolygonSub(args ...interface{}) Term

PolygonSub "punches a hole" out of the parent polygon using the polygon passed to the function.

polygon1.PolygonSub(polygon2) -> polygon

In the example above polygon2 must be completely contained within polygon1 and must have no holes itself (it must not be the output of polygon_sub itself).

func (Term) Prepend Uses

func (t Term) Prepend(args ...interface{}) Term

Prepend prepends a value to an array.

func (Term) ReadAll Uses

func (t Term) ReadAll(dest interface{}, s QueryExecutor, optArgs ...RunOpts) error

ReadAll is a shortcut method that runs the query on the given connection and reads all of the responses from the cursor before closing it.

It returns any errors encountered from running the query or reading the responses

func (Term) ReadOne Uses

func (t Term) ReadOne(dest interface{}, s QueryExecutor, optArgs ...RunOpts) error

ReadOne is a shortcut method that runs the query on the given connection and reads one response from the cursor before closing it.

It returns any errors encountered from running the query or reading the response

func (Term) Rebalance Uses

func (t Term) Rebalance() Term

Rebalance rebalances the shards of a table. When called on a database, all the tables in that database will be rebalanced.

func (Term) Reconfigure Uses

func (t Term) Reconfigure(optArgs ...ReconfigureOpts) Term

Reconfigure a table's sharding and replication.

func (Term) Reduce Uses

func (t Term) Reduce(args ...interface{}) Term

Reduce produces a single value from a sequence through repeated application of a reduction function

It takes one argument of type `func (r.Term, r.Term) interface{}`, for example this query sums all elements in an array:

r.Expr([]int{1,3,6}).Reduce(func (left, right r.Term) interface{} {
    return left.Add(right)
})

func (Term) Replace Uses

func (t Term) Replace(arg interface{}, optArgs ...ReplaceOpts) Term

Replace documents in a table. Accepts a JSON document or a ReQL expression, and replaces the original document with the new one. The new document must have the same primary key as the original document.

func (Term) Round Uses

func (t Term) Round(args ...interface{}) Term

Round causes the input number to be rounded the given value to the nearest whole integer.

func (Term) Run Uses

func (t Term) Run(s QueryExecutor, optArgs ...RunOpts) (*Cursor, error)

Run runs a query using the given connection.

	rows, err := query.Run(sess)
	if err != nil {
		// error
	}

 var doc MyDocumentType
	for rows.Next(&doc) {
     // Do something with document
	}

func (Term) RunWrite Uses

func (t Term) RunWrite(s QueryExecutor, optArgs ...RunOpts) (WriteResponse, error)

RunWrite runs a query using the given connection but unlike Run automatically scans the result into a variable of type WriteResponse. This function should be used if you are running a write query (such as Insert, Update, TableCreate, etc...).

If an error occurs when running the write query the first error is returned.

res, err := r.DB("database").Table("table").Insert(doc).RunWrite(sess)

func (Term) Sample Uses

func (t Term) Sample(args ...interface{}) Term

Sample selects a given number of elements from a sequence with uniform random distribution. Selection is done without replacement.

func (Term) Seconds Uses

func (t Term) Seconds(args ...interface{}) Term

Seconds returns the seconds in a time object as a number between 0 and 59.999 (double precision).

func (Term) SetDifference Uses

func (t Term) SetDifference(args ...interface{}) Term

SetDifference removes the elements of one array from another and return them as a set (an array with distinct values).

func (Term) SetInsert Uses

func (t Term) SetInsert(args ...interface{}) Term

SetInsert adds a value to an array and return it as a set (an array with distinct values).

func (Term) SetIntersection Uses

func (t Term) SetIntersection(args ...interface{}) Term

SetIntersection calculates the intersection of two arrays returning values that occur in both of them as a set (an array with distinct values).

func (Term) SetUnion Uses

func (t Term) SetUnion(args ...interface{}) Term

SetUnion adds several values to an array and return it as a set (an array with distinct values).

func (Term) Skip Uses

func (t Term) Skip(args ...interface{}) Term

Skip skips a number of elements from the head of the sequence.

func (Term) Slice Uses

func (t Term) Slice(args ...interface{}) Term

Slice trims the sequence to within the bounds provided.

func (Term) SpliceAt Uses

func (t Term) SpliceAt(args ...interface{}) Term

SpliceAt inserts several values in to an array at a given index. Returns the modified array.

func (Term) Split Uses

func (t Term) Split(args ...interface{}) Term

Split splits a string into substrings. Splits on whitespace when called with no arguments. When called with a separator, splits on that separator. When called with a separator and a maximum number of splits, splits on that separator at most max_splits times. (Can be called with null as the separator if you want to split on whitespace while still specifying max_splits.)

Mimics the behavior of Python's string.split in edge cases, except for splitting on the empty string, which instead produces an array of single-character strings.

func (Term) Status Uses

func (t Term) Status() Term

Status return the status of a table

func (Term) String Uses

func (t Term) String() string

String returns a string representation of the query tree

func (Term) Sub Uses

func (t Term) Sub(args ...interface{}) Term

Sub subtracts two numbers.

func (Term) Sum Uses

func (t Term) Sum(args ...interface{}) Term

Sum returns the sum of all the elements of a sequence. If called with a field name, sums all the values of that field in the sequence, skipping elements of the sequence that lack that field. If called with a function, calls that function on every element of the sequence and sums the results, skipping elements of the sequence where that function returns null or a non-existence error.

func (Term) Sync Uses

func (t Term) Sync(args ...interface{}) Term

Sync ensures that writes on a given table are written to permanent storage. Queries that specify soft durability do not give such guarantees, so Sync can be used to ensure the state of these queries. A call to Sync does not return until all previous writes to the table are persisted.

func (Term) Table Uses

func (t Term) Table(name interface{}, optArgs ...TableOpts) Term

Table selects all documents in a table. This command can be chained with other commands to do further processing on the data.

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

func (Term) TableCreate Uses

func (t Term) TableCreate(name interface{}, optArgs ...TableCreateOpts) Term

TableCreate creates a table. A RethinkDB table is a collection of JSON documents.

Note: Only alphanumeric characters and underscores are valid for the table name.

func (Term) TableDrop Uses

func (t Term) TableDrop(args ...interface{}) Term

TableDrop deletes a table. The table and all its data will be deleted.

func (Term) TableList Uses

func (t Term) TableList(args ...interface{}) Term

TableList lists all table names in a database.

func (Term) TimeOfDay Uses

func (t Term) TimeOfDay(args ...interface{}) Term

TimeOfDay returns the number of seconds elapsed since the beginning of the day stored in the time object.

func (Term) Timezone Uses

func (t Term) Timezone(args ...interface{}) Term

Timezone returns the timezone of the time object

func (Term) ToEpochTime Uses

func (t Term) ToEpochTime(args ...interface{}) Term

ToEpochTime converts a time object to its epoch time.

func (Term) ToGeoJSON Uses

func (t Term) ToGeoJSON(args ...interface{}) Term

ToGeoJSON converts a ReQL geometry object to a GeoJSON object.

func (Term) ToISO8601 Uses

func (t Term) ToISO8601(args ...interface{}) Term

ToISO8601 converts a time object to its iso 8601 format.

func (Term) ToJSON Uses

func (t Term) ToJSON() Term

ToJSON converts a ReQL value or object to a JSON string.

func (Term) TypeOf Uses

func (t Term) TypeOf(args ...interface{}) Term

TypeOf gets the type of a value.

func (Term) Ungroup Uses

func (t Term) Ungroup(args ...interface{}) Term

Ungroup takes a grouped stream or grouped data and turns it into an array of objects representing the groups. Any commands chained after Ungroup will operate on this array, rather than operating on each group individually. This is useful if you want to e.g. order the groups by the value of their reduction.

func (Term) Union Uses

func (t Term) Union(args ...interface{}) Term

Union concatenates two sequences.

func (Term) UnionWithOpts Uses

func (t Term) UnionWithOpts(optArgs UnionOpts, args ...interface{}) Term

UnionWithOpts like Union concatenates two sequences however allows for optional arguments to be passed.

func (Term) Upcase Uses

func (t Term) Upcase(args ...interface{}) Term

Upcase upper-cases a string.

func (Term) Update Uses

func (t Term) Update(arg interface{}, optArgs ...UpdateOpts) Term

Update JSON documents in a table. Accepts a JSON document, a ReQL expression, or a combination of the two. You can pass options like returnChanges that will return the old and new values of the row you have modified.

func (Term) Values Uses

func (t Term) Values(args ...interface{}) Term

func (Term) Wait Uses

func (t Term) Wait(optArgs ...WaitOpts) Term

Wait for a table or all the tables in a database to be ready. A table may be temporarily unavailable after creation, rebalancing or reconfiguring. The wait command blocks until the given table (or database) is fully up to date.

func (Term) WithFields Uses

func (t Term) WithFields(args ...interface{}) Term

WithFields takes a sequence of objects and a list of fields. If any objects in the sequence don't have all of the specified fields, they're dropped from the sequence. The remaining objects have the specified fields plucked out. (This is identical to `HasFields` followed by `Pluck` on a sequence.)

func (Term) Without Uses

func (t Term) Without(args ...interface{}) Term

Without is the opposite of pluck; takes an object or a sequence of objects, and returns them with the specified paths removed.

func (Term) Year Uses

func (t Term) Year(args ...interface{}) Term

Year returns the year of a time object.

func (Term) Zip Uses

func (t Term) Zip(args ...interface{}) Term

Zip is used to 'zip' up the result of a join by merging the 'right' fields into 'left' fields of each member of the sequence.

type UnionOpts Uses

type UnionOpts struct {
    Interleave interface{} `rethinkdb:"interleave,omitempty"`
}

UnionOpts contains the optional arguments for the Slice term

type UpdateOpts Uses

type UpdateOpts struct {
    Durability    interface{} `rethinkdb:"durability,omitempty"`
    ReturnChanges interface{} `rethinkdb:"return_changes,omitempty"`
    NonAtomic     interface{} `rethinkdb:"non_atomic,omitempty"`
    Conflict      interface{} `rethinkdb:"conflict,omitempty"`
}

UpdateOpts contains the optional arguments for the Update term

type WaitOpts Uses

type WaitOpts struct {
    WaitFor interface{} `rethinkdb:"wait_for,omitempty"`
    Timeout interface{} `rethinkdb:"timeout,omitempty"`
}

WaitOpts contains the optional arguments for the Wait term.

type WriteResponse Uses

type WriteResponse struct {
    Errors        int              `rethinkdb:"errors"`
    Inserted      int              `rethinkdb:"inserted"`
    Updated       int              `rethinkdb:"updated"`
    Unchanged     int              `rethinkdb:"unchanged"`
    Replaced      int              `rethinkdb:"replaced"`
    Renamed       int              `rethinkdb:"renamed"`
    Skipped       int              `rethinkdb:"skipped"`
    Deleted       int              `rethinkdb:"deleted"`
    Created       int              `rethinkdb:"created"`
    DBsCreated    int              `rethinkdb:"dbs_created"`
    TablesCreated int              `rethinkdb:"tables_created"`
    Dropped       int              `rethinkdb:"dropped"`
    DBsDropped    int              `rethinkdb:"dbs_dropped"`
    TablesDropped int              `rethinkdb:"tables_dropped"`
    GeneratedKeys []string         `rethinkdb:"generated_keys"`
    FirstError    string           `rethinkdb:"first_error"` // populated if Errors > 0
    ConfigChanges []ChangeResponse `rethinkdb:"config_changes"`
    Changes       []ChangeResponse
}

WriteResponse is a helper type used when dealing with the response of a write query. It is also returned by the RunWrite function.

Directories

PathSynopsis
ql2
types

Package rethinkdb imports 34 packages (graph) and is imported by 298 packages. Updated 2018-12-06. Refresh now. Tools for package owners.