connection

package

v0.0.0-...-5c79d48 Latest Latest Go to latest Published: Feb 15, 2024 License: AGPL-3.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/juser0719/teleport

Documentation ¶

Index ¶

Constants
type Mode
type Options
- func ParseRedisAddress(addr string) (*Options, error)
- func ParseRedisAddressWithDefaultMode(addr string, defaultMode Mode) (*Options, error)

Constants ¶

View Source

const (
	// URIScheme is a Redis scheme: https://www.iana.org/assignments/uri-schemes/prov/redis
	// Teleport always uses Redis connection over TLS.
	URIScheme = "redis"
	// URISchemeTLS is a Redis scheme that uses TLS for database connection: https://www.iana.org/assignments/uri-schemes/prov/rediss
	URISchemeTLS = "rediss"
)

View Source

const DefaultPort = "6379"

DefaultPort is the Redis default port.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Mode ¶

type Mode string

Mode defines the mode in which Redis is configured. Currently, supported are single and cluster.

const (
	// Standalone mode should be used when connecting to a single Redis instance.
	Standalone Mode = "standalone"
	// Cluster mode should be used when connecting to a Redis Cluster.
	Cluster Mode = "cluster"
)

type Options ¶

type Options struct {
	// Mode defines Redis connection mode like cluster or single instance.
	Mode Mode
	// address of Redis instance.
	Address string
	// port on which Redis expects new connections.
	Port string
}

Options defines Redis connection options.

func ParseRedisAddress ¶

func ParseRedisAddress(addr string) (*Options, error)

ParseRedisAddress parses a Redis connection string and returns the parsed connection options like address and connection mode. If port is skipped default Redis 6379 is used. Correct inputs:

rediss://redis.example.com:6379?mode=cluster
redis://redis.example.com:6379
redis.example.com:6379

Incorrect input:

redis.example.com:6379?mode=cluster

func ParseRedisAddressWithDefaultMode ¶

func ParseRedisAddressWithDefaultMode(addr string, defaultMode Mode) (*Options, error)

ParseRedisAddressWithDefaultMode parses a Redis connection string and uses the provided default mode if mode is not specified in the address.

Source Files ¶

View all Source files

connection.go

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