ldredis

package
Version: v5.0.0-beta.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 3, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package ldredis provides a Redis-backed persistent data store for the LaunchDarkly Go SDK.

For more details about how and why you can use a persistent data store, see: https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store

To use the Redis data store with the LaunchDarkly client:

config := ld.Config{
    DataStore: ldcomponents.PersistentDataStore(ldredis.DataStore()),
}
client, err := ld.MakeCustomClient("sdk-key", config, 5*time.Second)

The default Redis pool configuration uses an address of localhost:6379, a maximum of 16 concurrent connections, and blocking connection requests. You may customize the configuration by using the methods of the ldredis.DataStoreBuilder returned by ldredis.DataStore():

config := ld.Config{
    DataStore: ldcomponents.PersistentDataStore(
        ldredis.DataStore().URL(myRedisURL),
    ).CacheSeconds(30),
}

Note that CacheSeconds() is not a method of ldredis.DataStoreBuilder, but rather a method of ldcomponents.PersistentDataStore(), because the caching behavior is provided by the SDK for all database integrations.

For advanced customization of the underlying Redigo client, use the DialOptions or Pool options with ldredis.DataStore(). Note that some Redis client features can also be specified as part of the URL: Redigo supports the redis:// syntax (https://www.iana.org/assignments/uri-schemes/prov/redis), which can include a password and a database number, as well as rediss:// (https://www.iana.org/assignments/uri-schemes/prov/rediss), which enables TLS.

If you are also using Redis for other purposes, the data store can coexist with other data as long as you are not using the same keys. By default, the keys used by the data store will always start with "launchdarkly:"; you can change this to another prefix if desired.

Index

Constants

View Source
const (
	// DefaultURL is the default URL for connecting to Redis, if you use
	// NewRedisDataStoreWithDefaults. You can specify otherwise with the RedisURL option.
	// If you are using the other constructors, you must specify the URL explicitly.
	DefaultURL = "redis://localhost:6379"
	// DefaultPrefix is a string that is prepended (along with a colon) to all Redis keys used
	// by the data store. You can change this value with the Prefix() option for
	// NewRedisDataStoreWithDefaults, or with the "prefix" parameter to the other constructors.
	DefaultPrefix = "launchdarkly"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type DataStoreBuilder

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

DataStoreBuilder is a builder for configuring the Redis-based persistent data store.

Obtain an instance of this type by calling DataStore(). After calling its methods to specify any desired custom settings, wrap it in a PersistentDataStoreBuilder by calling ldcomponents.PersistentDataStore(), and then store this in the SDK configuration's DataStore field.

Builder calls can be chained, for example:

config.DataStore = ldredis.DataStore().URL("redis://hostname").Prefix("prefix")

You do not need to call the builder's CreatePersistentDataStore() method yourself to build the actual data store; that will be done by the SDK.

func DataStore

func DataStore() *DataStoreBuilder

DataStore returns a configurable builder for a Redis-backed data store.

func (*DataStoreBuilder) CreatePersistentDataStore

func (b *DataStoreBuilder) CreatePersistentDataStore(
	context interfaces.ClientContext,
) (interfaces.PersistentDataStore, error)

CreatePersistentDataStore is called internally by the SDK to create the data store implementation object.

func (*DataStoreBuilder) DescribeConfiguration

func (b *DataStoreBuilder) DescribeConfiguration() ldvalue.Value

DescribeConfiguration is used internally by the SDK to inspect the configuration.

func (*DataStoreBuilder) DialOptions

func (b *DataStoreBuilder) DialOptions(options ...r.DialOption) *DataStoreBuilder

DialOptions specifies any of the advanced Redis connection options supported by Redigo, such as DialPassword.

import (
    redigo "github.com/garyburd/redigo/redis"
    "gopkg.in/launchdarkly/go-server-sdk.v5/ldredis"
)
config.DataSource = ldcomponents.PersistentDataStore(
    ldredis.DataStore().DialOptions(redigo.DialPassword("verysecure123")),
)

Note that some Redis client features can also be specified as part of the URL: see URL().

func (*DataStoreBuilder) HostAndPort

func (b *DataStoreBuilder) HostAndPort(host string, port int) *DataStoreBuilder

HostAndPort is a shortcut for specifying the Redis host address as a hostname and port.

func (*DataStoreBuilder) Pool

func (b *DataStoreBuilder) Pool(pool *r.Pool) *DataStoreBuilder

Pool specifies that the data store should use a specific connection pool configuration. If not specified, it will create a default configuration (see package description). Specifying this option will cause any address specified with URL() or HostAndPort() to be ignored.

If you only need to change basic connection options such as providing a password, it is simpler to use DialOptions().

func (*DataStoreBuilder) Prefix

func (b *DataStoreBuilder) Prefix(prefix string) *DataStoreBuilder

Prefix specifies a string that should be prepended to all Redis keys used by the data store. A colon will be added to this automatically. If this is unspecified or empty, DefaultPrefix will be used.

func (*DataStoreBuilder) URL

URL specifies the Redis host URL. If not specified, the default value is DefaultURL.

Note that some Redis client features can also be specified as part of the URL: Redigo supports the redis:// syntax (https://www.iana.org/assignments/uri-schemes/prov/redis), which can include a password and a database number, as well as rediss:// (https://www.iana.org/assignments/uri-schemes/prov/rediss), which enables TLS.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL