forked from launchdarkly/go-server-sdk-redis-redigo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
package_info.go
40 lines (40 loc) · 1.99 KB
/
package_info.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
// 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:
//
// import ldredis "github.com/launchdarkly/go-server-sdk-redis-redigo/v3"
//
// 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 [StoreBuilder] returned by [DataStore]:
//
// config := ld.Config{
// DataStore: ldcomponents.PersistentDataStore(
// ldredis.DataStore().URL(myRedisURL),
// ).CacheSeconds(30),
// }
//
// Note that CacheSeconds() is not a method of [StoreBuilder], 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 [StoreBuilder] methods such
// as [StoreBuilder.DialOptions] and [StoreBuilder.Pool]. 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.
package ldredis