Documentation
¶
Index ¶
- type Client
- func (c *Client) Close() error
- func (c *Client) Health() (*client.HealthResult, error)
- func (c *Client) QueryGrouped(ctx context.Context, q query.UnparsedGroupedQuery) (*query.GroupedQueryResults, error)
- func (c *Client) QueryRaw(ctx context.Context, q query.UnparsedRawQuery) (*query.RawQueryResults, error)
- func (c *Client) QueryTimeBucket(ctx context.Context, q query.UnparsedTimeBucketQuery) (*query.TimeBucketQueryResults, error)
- func (c *Client) Write(ctx context.Context, namespace []byte, documents []document.Document) error
- type Options
- func (o *Options) ClockOptions() clock.Options
- func (o *Options) DialTimeout() time.Duration
- func (o *Options) InstrumentOptions() instrument.Options
- func (o *Options) KeepAlivePeriod() time.Duration
- func (o *Options) MaxRecvMsgSize() int
- func (o *Options) ReadTimeout() time.Duration
- func (o *Options) SetClockOptions(v clock.Options) *Options
- func (o *Options) SetDialTimeout(v time.Duration) *Options
- func (o *Options) SetInstrumentOptions(v instrument.Options) *Options
- func (o *Options) SetKeepAlivePeriod(v time.Duration) *Options
- func (o *Options) SetMaxRecvMsgSize(v int) *Options
- func (o *Options) SetReadTimeout(v time.Duration) *Options
- func (o *Options) SetUseCompression(v bool) *Options
- func (o *Options) SetUseInsecure(v bool) *Options
- func (o *Options) SetWriteBufferSize(v int) *Options
- func (o *Options) SetWriteTimeout(v time.Duration) *Options
- func (o *Options) UseCompression() bool
- func (o *Options) UseInsecure() bool
- func (o *Options) WriteBufferSize() int
- func (o *Options) WriteTimeout() time.Duration
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a GRPC client.
func (*Client) Health ¶
func (c *Client) Health() (*client.HealthResult, error)
Health performs a health check against the database.
func (*Client) QueryGrouped ¶
func (c *Client) QueryGrouped( ctx context.Context, q query.UnparsedGroupedQuery, ) (*query.GroupedQueryResults, error)
QueryGrouped performs a grouped query.
func (*Client) QueryRaw ¶
func (c *Client) QueryRaw( ctx context.Context, q query.UnparsedRawQuery, ) (*query.RawQueryResults, error)
QueryRaw performs a raw query.
func (*Client) QueryTimeBucket ¶
func (c *Client) QueryTimeBucket( ctx context.Context, q query.UnparsedTimeBucketQuery, ) (*query.TimeBucketQueryResults, error)
QueryTimeBucket performs a time bucket query.
type Options ¶
type Options struct {
// contains filtered or unexported fields
}
Options provide a set of client options.
func (*Options) ClockOptions ¶
ClockOptions returns the clock options.
func (*Options) DialTimeout ¶
DialTimeout returns the dial timeout. When this is non zero, the initial dialing is blocking until the connection is established.
func (*Options) InstrumentOptions ¶
func (o *Options) InstrumentOptions() instrument.Options
InstrumentOptions returns the instrument options.
func (*Options) KeepAlivePeriod ¶
KeepAlivePeriod returns the keep alive period.
func (*Options) MaxRecvMsgSize ¶
MaxRecvMsgSize returns the max message size in bytes the server can receive.
func (*Options) ReadTimeout ¶
ReadTimeout returns the read timeout.
func (*Options) SetClockOptions ¶
SetClockOptions sets the clock options.
func (*Options) SetDialTimeout ¶
SetDialTimeout sets the dial timeout for establishing the initial connection. When this is non zero, the initial dialing is blocking until the connection is established.
func (*Options) SetInstrumentOptions ¶
func (o *Options) SetInstrumentOptions(v instrument.Options) *Options
SetInstrumentOptions sets the instrument options.
func (*Options) SetKeepAlivePeriod ¶
SetKeepAlivePeriod sets the keep alive period.
func (*Options) SetMaxRecvMsgSize ¶
SetMaxRecvMsgSize sets the max message size in bytes the server can receive.
func (*Options) SetReadTimeout ¶
SetReadTimeout sets the read timeout.
func (*Options) SetUseCompression ¶
SetUseCompression sets whether to use compression.
func (*Options) SetUseInsecure ¶
SetUseInsecure sets whether to use insecure connection.
func (*Options) SetWriteBufferSize ¶
SetWriteBufferSize sets the read buffer size. This determines how much data can be read at most for one read syscall.
func (*Options) SetWriteTimeout ¶
SetWriteTimeout sets the write timeout.
func (*Options) UseCompression ¶
UseCompression returns whether to use compression.
func (*Options) UseInsecure ¶
UseInsecure returns whether to use insecure connection.
func (*Options) WriteBufferSize ¶
WriteBufferSize returns the read buffer size. This determines how much data can be read at most for one read syscall.
func (*Options) WriteTimeout ¶
WriteTimeout returns the write timeout.
Source Files