Dagger
Search

redis

This module is designed for development and CI purposes only, do not use it to host a production server. The module implements a server and a client that can work together.

You can use it to run a local Redis server but also in your CI pipeline to test your application with integrations tests.

Installation

dagger install github.com/quartz-technology/daggerverse/redis@v0.0.3

Entrypoint

Return Type 
Redis !
Arguments
NameTypeDescription
portInteger The port to use for the Redis server.
versionString The version of the Redis server to use.
passwordSecret The password to use for the Redis server.
cacheBoolean Enable data persistency by mounting a cache volume.
Example
func (m *myModule) example() *Redis  {
	return dag.
			Redis()
}
@function
def example() -> dag.Redis:
	return (
		dag.redis()
	)
@func()
example(): Redis {
	return dag
		.redis()
}

Types

Redis

port()

Return Type 
Integer !
Example
dagger -m github.com/quartz-technology/daggerverse/redis@627fc4df7de8ce3bd8710fa08ea2db6cf16712b3 call \
 port
func (m *myModule) example(ctx context.Context) int  {
	return dag.
			Redis().
			Port(ctx)
}
@function
async def example() -> int:
	return await (
		dag.redis()
		.port()
	)
@func()
async example(): Promise<number> {
	return dag
		.redis()
		.port()
}

version()

Return Type 
String !
Example
dagger -m github.com/quartz-technology/daggerverse/redis@627fc4df7de8ce3bd8710fa08ea2db6cf16712b3 call \
 version
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Redis().
			Version(ctx)
}
@function
async def example() -> str:
	return await (
		dag.redis()
		.version()
	)
@func()
async example(): Promise<string> {
	return dag
		.redis()
		.version()
}

password()

Return Type 
Secret !
Example
dagger -m github.com/quartz-technology/daggerverse/redis@627fc4df7de8ce3bd8710fa08ea2db6cf16712b3 call \
 password
func (m *myModule) example() *Secret  {
	return dag.
			Redis().
			Password()
}
@function
def example() -> dagger.Secret:
	return (
		dag.redis()
		.password()
	)
@func()
example(): Secret {
	return dag
		.redis()
		.password()
}

cache()

Return Type 
Boolean !
Example
dagger -m github.com/quartz-technology/daggerverse/redis@627fc4df7de8ce3bd8710fa08ea2db6cf16712b3 call \
 cache
func (m *myModule) example(ctx context.Context) bool  {
	return dag.
			Redis().
			Cache(ctx)
}
@function
async def example() -> bool:
	return await (
		dag.redis()
		.cache()
	)
@func()
async example(): Promise<boolean> {
	return dag
		.redis()
		.cache()
}

cli()

CLI returns a new container running the Redis CLI connected to a redis Service.

Return Type 
Cli !
Arguments
NameTypeDefault ValueDescription
serverService !-The Redis server to connect to.
Example
dagger -m github.com/quartz-technology/daggerverse/redis@627fc4df7de8ce3bd8710fa08ea2db6cf16712b3 call \
 cli --server PROTOCOL://HOST:PORT \
 container
func (m *myModule) example(server *Service) *RedisCli  {
	return dag.
			Redis().
			Cli(server)
}
@function
def example(server: dagger.Service) -> dag.RedisCli:
	return (
		dag.redis()
		.cli(server)
	)
@func()
example(server: Service): RedisCli {
	return dag
		.redis()
		.cli(server)
}

server()

Server returns a new container running Redis a redis Server.

Return Type 
Container !
Example
dagger -m github.com/quartz-technology/daggerverse/redis@627fc4df7de8ce3bd8710fa08ea2db6cf16712b3 call \
 server
func (m *myModule) example() *Container  {
	return dag.
			Redis().
			Server()
}
@function
def example() -> dagger.Container:
	return (
		dag.redis()
		.server()
	)
@func()
example(): Container {
	return dag
		.redis()
		.server()
}

Cli

ctr()

Return Type 
Container !
Example
dagger -m github.com/quartz-technology/daggerverse/redis@627fc4df7de8ce3bd8710fa08ea2db6cf16712b3 call \
 cli --server PROTOCOL://HOST:PORT \
 ctr
func (m *myModule) example(server *Service) *Container  {
	return dag.
			Redis().
			Cli(server).
			Ctr()
}
@function
def example(server: dagger.Service) -> dagger.Container:
	return (
		dag.redis()
		.cli(server)
		.ctr()
	)
@func()
example(server: Service): Container {
	return dag
		.redis()
		.cli(server)
		.ctr()
}

container()

Return Type 
Container !
Example
dagger -m github.com/quartz-technology/daggerverse/redis@627fc4df7de8ce3bd8710fa08ea2db6cf16712b3 call \
 cli --server PROTOCOL://HOST:PORT \
 container
func (m *myModule) example(server *Service) *Container  {
	return dag.
			Redis().
			Cli(server).
			Container()
}
@function
def example(server: dagger.Service) -> dagger.Container:
	return (
		dag.redis()
		.cli(server)
		.container()
	)
@func()
example(server: Service): Container {
	return dag
		.redis()
		.cli(server)
		.container()
}

set()

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
keyString !-No description provided
valueString !-No description provided
Example
dagger -m github.com/quartz-technology/daggerverse/redis@627fc4df7de8ce3bd8710fa08ea2db6cf16712b3 call \
 cli --server PROTOCOL://HOST:PORT \
 set --key string --value string
func (m *myModule) example(server *Service, key string, value string) *Container  {
	return dag.
			Redis().
			Cli(server).
			Set(key, value)
}
@function
def example(server: dagger.Service, key: str, value: str) -> dagger.Container:
	return (
		dag.redis()
		.cli(server)
		.set(key, value)
	)
@func()
example(server: Service, key: string, value: string): Container {
	return dag
		.redis()
		.cli(server)
		.set(key, value)
}

get()

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
keyString !-No description provided
Example
dagger -m github.com/quartz-technology/daggerverse/redis@627fc4df7de8ce3bd8710fa08ea2db6cf16712b3 call \
 cli --server PROTOCOL://HOST:PORT \
 get --key string
func (m *myModule) example(ctx context.Context, server *Service, key string) string  {
	return dag.
			Redis().
			Cli(server).
			Get(ctx, key)
}
@function
async def example(server: dagger.Service, key: str) -> str:
	return await (
		dag.redis()
		.cli(server)
		.get(key)
	)
@func()
async example(server: Service, key: string): Promise<string> {
	return dag
		.redis()
		.cli(server)
		.get(key)
}