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@d58a027ddcaf210b6e2c5feba307c3b48fdb0255Entrypoint
Return Type
Redis !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| port | Integer | 6379 | The port to use for the Redis server. |
| version | String | "7.2.4" | The version of the Redis server to use. |
| password | Secret | - | The password to use for the Redis server. |
| cache | Boolean | false | Enable data persistency by mounting a cache volume. |
| cacheDataPath | String | "\"/data/" | If cache is enabled define the path where the cache is set. |
| image | String | "redis" | The image of the redis server to use. |
Example
dagger -m github.com/quartz-technology/daggerverse/redis@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
func (m *MyModule) Example() *dagger.Redis {
return dag.
Redis()
}@function
def example() -> dagger.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@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
portfunc (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@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
versionfunc (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@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
passwordfunc (m *MyModule) Example() *dagger.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@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
cachefunc (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()
}cacheDataPath() 🔗
Return Type
String ! Example
dagger -m github.com/quartz-technology/daggerverse/redis@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
cache-data-pathfunc (m *MyModule) Example(ctx context.Context) string {
return dag.
Redis().
CacheDataPath(ctx)
}@function
async def example() -> str:
return await (
dag.redis()
.cache_data_path()
)@func()
async example(): Promise<string> {
return dag
.redis()
.cacheDataPath()
}image() 🔗
Return Type
String ! Example
dagger -m github.com/quartz-technology/daggerverse/redis@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
imagefunc (m *MyModule) Example(ctx context.Context) string {
return dag.
Redis().
Image(ctx)
}@function
async def example() -> str:
return await (
dag.redis()
.image()
)@func()
async example(): Promise<string> {
return dag
.redis()
.image()
}cli() 🔗
CLI returns a new container running the Redis CLI connected to a redis Service.
Return Type
Cli !Arguments
| Name | Type | Default Value | Description |
|---|---|---|---|
| server | Service ! | - | The Redis server to connect to. |
Example
dagger -m github.com/quartz-technology/daggerverse/redis@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
cli --server PROTOCOL://HOST:PORTfunc (m *MyModule) Example(server *dagger.Service) *dagger.RedisCli {
return dag.
Redis().
Cli(server)
}@function
def example(server: dagger.Service) -> dagger.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@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
serverfunc (m *MyModule) Example() *dagger.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@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
cli --server PROTOCOL://HOST:PORT \
ctrfunc (m *MyModule) Example(server *dagger.Service) *dagger.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@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
cli --server PROTOCOL://HOST:PORT \
containerfunc (m *MyModule) Example(server *dagger.Service) *dagger.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
| Name | Type | Default Value | Description |
|---|---|---|---|
| key | String ! | - | No description provided |
| value | String ! | - | No description provided |
Example
dagger -m github.com/quartz-technology/daggerverse/redis@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
cli --server PROTOCOL://HOST:PORT \
set --key string --value stringfunc (m *MyModule) Example(server *dagger.Service, key string, value string) *dagger.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
| Name | Type | Default Value | Description |
|---|---|---|---|
| key | String ! | - | No description provided |
Example
dagger -m github.com/quartz-technology/daggerverse/redis@d58a027ddcaf210b6e2c5feba307c3b48fdb0255 call \
cli --server PROTOCOL://HOST:PORT \
get --key stringfunc (m *MyModule) Example(ctx context.Context, server *dagger.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)
}