Merge pull request #2 from quackscience/resecrets

Secrets Support for Redis Client

Author: lmangani

CMakeLists.txt

@@ -15,7 +15,11 @@ include_directories(
     ${Boost_INCLUDE_DIRS}
 )
 
-set(EXTENSION_SOURCES src/redis_extension.cpp)
+# Add redis_secret.cpp to the sources
+set(EXTENSION_SOURCES 
+    src/redis_extension.cpp
+    src/redis_secret.cpp
+)
 
 build_static_extension(${TARGET_NAME} ${EXTENSION_SOURCES})
 build_loadable_extension(${TARGET_NAME} " " ${EXTENSION_SOURCES})

docs/README.md

@@ -7,234 +7,127 @@ This extension provides Redis client functionality for DuckDB, allowing you to i
 
 ## Features
 Currently supported Redis operations:
-- `redis_get(key, host, port, password)`: Retrieves a value from Redis for a given key
-- `redis_set(key, value, host, port, password)`: Sets a value in Redis for a given key
+- String operations: `GET`, `SET`
+- Hash operations: `HGET`, `HSET`
+- List operations: `LPUSH`, `LRANGE`
 
-Features:
-- Connection pooling for improved performance
-- Redis authentication support
-- Thread-safe operations
-- Detailed error handling
 
 ## Installation
 ```sql
 INSTALL redis FROM community;
 LOAD redis;
 ```
 
-## Usage Examples
-### Connecting with Authentication
-```sql
--- Set a value with authentication
-SELECT redis_set('user:1', 'John Doe', 'localhost', '6379', 'mypassword') as result;
-
--- Get a value with authentication
-SELECT redis_get('user:1', 'localhost', '6379', 'mypassword') as user_name;
+## Usage
+### Setting up Redis Connection
+First, create a secret to store your Redis connection details:
 
--- For non-authenticated Redis servers, pass an empty string as password
-SELECT redis_get('user:1', 'localhost', '6379', '') as user_name;
-```
-
-### Setting Values in Redis
 ```sql
--- Set a single value
-SELECT redis_set('user:1', 'John Doe', 'localhost', '6379') as result;
+-- Create a Redis connection secret
+CREATE SECRET IF NOT EXISTS redis (
+        TYPE redis,
+        PROVIDER config,
+        host 'localhost',
+        port '6379',
+        password 'optional_password'
+    );
+
+-- Create a Redis cloud connection secret
+CREATE SECRET IF NOT EXISTS redis (
+        TYPE redis,
+        PROVIDER config,
+        host 'redis-1234.ec2.redns.redis-cloud.com',
+        port '16959',
+        password 'xxxxxx'
+    );
+```
+
+### String Operations
+```sql
+-- Set a value
+SELECT redis_set('user:1', 'John Doe', 'redis') as result;
+
+-- Get a value
+SELECT redis_get('user:1', 'redis') as user_name;
 
 -- Set multiple values in a query
-INSERT INTO users (id, name, age)
-SELECT redis_set(
+INSERT INTO users (id, name)
+SELECT id, redis_set(
     'user:' || id::VARCHAR,
     name,
-    'localhost',
-    '6379'
+    'my_redis'
 )
 FROM new_users;
 ```
 
-### Getting Values from Redis
+### Hash Operations
 ```sql
--- Get a single value
-SELECT redis_get('user:1', 'localhost', '6379') as user_name;
-
--- Get multiple values
-SELECT 
-    id,
-    redis_get('user:' || id::VARCHAR, 'localhost', '6379') as user_data
-FROM user_ids;
+-- Set hash fields
+SELECT redis_hset('user:1', 'email', '[email protected]', 'redis');
+SELECT redis_hset('user:1', 'age', '30', 'redis');
+
+-- Get hash field
+SELECT redis_hget('user:1', 'email', 'redis') as email;
+
+-- Store user profile as hash
+WITH profile(id, field, value) AS (
+    VALUES 
+        (1, 'name', 'John Doe'),
+        (1, 'email', '[email protected]'),
+        (1, 'age', '30')
+)
+SELECT redis_hset(
+    'user:' || id::VARCHAR,
+    field,
+    value,
+    'redis'
+)
+FROM profile;
 ```
 
-## Building from Source
-Follow the standard DuckDB extension build process:
+### List Operations
+```sql
+-- Push items to list
+SELECT redis_lpush('mylist', 'first_item', 'redis');
+SELECT redis_lpush('mylist', 'second_item', 'redis');
 
-```sh
-# Install vcpkg dependencies
-./vcpkg/vcpkg install boost-asio
+-- Get range from list (returns comma-separated values)
+-- Get all items (0 to -1 means start to end)
+SELECT redis_lrange('mylist', 0, -1, 'redis') as items;
 
-# Build the extension
-make
-```
+-- Get first 5 items
+SELECT redis_lrange('mylist', 0, 4, 'redis') as items;
 
-## Dependencies
-- Boost.Asio (header-only, installed via vcpkg)
+-- Push multiple items
+WITH items(value) AS (
+    VALUES ('item1'), ('item2'), ('item3')
+)
+SELECT redis_lpush('mylist', value, 'redis')
+FROM items;
+```
 
 ## Error Handling
 The extension functions will throw exceptions with descriptive error messages when:
+- Redis secret is not found or invalid
 - Unable to connect to Redis server
 - Network communication errors occur
 - Invalid Redis protocol responses are received
 
-## Future Enhancements
-Planned features include:
-- Support for Redis authentication
-- Connection pooling for better performance
-- Additional Redis commands (HGET, HSET, LPUSH, etc.)
-- Table functions for scanning Redis keys
-- Batch operations using Redis pipelines
-- Connection timeout handling
-
-# DuckDB Extension Template
-This repository contains a template for creating a DuckDB extension. The main goal of this template is to allow users to easily develop, test and distribute their own DuckDB extension. The main branch of the template is always based on the latest stable DuckDB allowing you to try out your extension right away.
+## Building from Source
+Follow the standard DuckDB extension build process:
 
-## Getting started
-First step to getting started is to create your own repo from this template by clicking `Use this template`. Then clone your new repository using 
 ```sh
-git clone --recurse-submodules https://github.com/<you>/<your-new-extension-repo>.git
-```
-Note that `--recurse-submodules` will ensure DuckDB is pulled which is required to build the extension.
-
-## Building
-### Managing dependencies
-DuckDB extensions uses VCPKG for dependency management. Enabling VCPKG is very simple: follow the [installation instructions](https://vcpkg.io/en/getting-started) or just run the following:
-```shell
-cd <your-working-dir-not-the-plugin-repo>
-git clone https://github.com/Microsoft/vcpkg.git
-sh ./vcpkg/scripts/bootstrap.sh -disableMetrics
-export VCPKG_TOOLCHAIN_PATH=`pwd`/vcpkg/scripts/buildsystems/vcpkg.cmake
-```
-Note: VCPKG is only required for extensions that want to rely on it for dependency management. If you want to develop an extension without dependencies, or want to do your own dependency management, just skip this step. Note that the example extension uses VCPKG to build with a dependency for instructive purposes, so when skipping this step the build may not work without removing the dependency.
+# Install vcpkg dependencies
+./vcpkg/vcpkg install boost-asio
 
-### Build steps
-Now to build the extension, run:
-```sh
+# Build the extension
 make
 ```
-The main binaries that will be built are:
-```sh
-./build/release/duckdb
-./build/release/test/unittest
-./build/release/extension/<extension_name>/<extension_name>.duckdb_extension
-```
-- `duckdb` is the binary for the duckdb shell with the extension code automatically loaded. 
-- `unittest` is the test runner of duckdb. Again, the extension is already linked into the binary.
-- `<extension_name>.duckdb_extension` is the loadable binary as it would be distributed.
-
-### Tips for speedy builds
-DuckDB extensions currently rely on DuckDB's build system to provide easy testing and distributing. This does however come at the downside of requiring the template to build DuckDB and its unittest binary every time you build your extension. To mitigate this, we highly recommend installing [ccache](https://ccache.dev/) and [ninja](https://ninja-build.org/). This will ensure you only need to build core DuckDB once and allows for rapid rebuilds.
-
-To build using ninja and ccache ensure both are installed and run:
-
-```sh
-GEN=ninja make
-```
-
-## Running the extension
-To run the extension code, simply start the shell with `./build/release/duckdb`. This shell will have the extension pre-loaded.  
-
-Now we can use the features from the extension directly in DuckDB. The template contains a single scalar function `quack()` that takes a string arguments and returns a string:
-```
-D select quack('Jane') as result;
-┌───────────────┐
-│    result     │
-│    varchar    │
-├───────────────┤
-│ Quack Jane 🐥 │
-└───────────────┘
-```
 
-## Running the tests
-Different tests can be created for DuckDB extensions. The primary way of testing DuckDB extensions should be the SQL tests in `./test/sql`. These SQL tests can be run using:
-```sh
-make test
-```
-
-## Getting started with your own extension
-After creating a repository from this template, the first step is to name your extension. To rename the extension, run:
-```
-python3 ./scripts/bootstrap-template.py <extension_name_you_want>
-```
-Feel free to delete the script after this step.
-
-Now you're good to go! After a (re)build, you should now be able to use your duckdb extension:
-```
-./build/release/duckdb
-D select <extension_name_you_chose>('Jane') as result;
-┌─────────────────────────────────────┐
-│                result               │
-│               varchar               │
-├─────────────────────────────────────┤
-│ <extension_name_you_chose> Jane 🐥  │
-└─────────────────────────────────────┘
-```
-
-For inspiration/examples on how to extend DuckDB in a more meaningful way, check out the [test extensions](https://github.com/duckdb/duckdb/blob/main/test/extension),
-the [in-tree extensions](https://github.com/duckdb/duckdb/tree/main/extension), and the [out-of-tree extensions](https://github.com/duckdblabs).
-
-## Distributing your extension
-To distribute your extension binaries, there are a few options.
-
-### Community extensions
-The recommended way of distributing extensions is through the [community extensions repository](https://github.com/duckdb/community-extensions).
-This repository is designed specifically for extensions that are built using this extension template, meaning that as long as your extension can be
-built using the default CI in this template, submitting it to the community extensions is a very simple process. The process works similarly to popular
-package managers like homebrew and vcpkg, where a PR containing a descriptor file is submitted to the package manager repository. After the CI in the 
-community extensions repository completes, the extension can be installed and loaded in DuckDB with:
-```SQL
-INSTALL <my_extension> FROM community;
-LOAD <my_extension>
-```
-For more information, see the [community extensions documentation](https://duckdb.org/community_extensions/documentation).
-
-### Downloading artifacts from GitHub
-The default CI in this template will automatically upload the binaries for every push to the main branch as GitHub Actions artifacts. These
-can be downloaded manually and then loaded directly using:
-```SQL
-LOAD '/path/to/downloaded/extension.duckdb_extension';
-```
-Note that this will require starting DuckDB with the
-`allow_unsigned_extensions` option set to true. How to set this will depend on the client you're using. For the CLI it is done like:
-```shell
-duckdb -unsigned
-```
-
-### Uploading to a custom repository
-If for some reason distributing through community extensions is not an option, extensions can also be uploaded to a custom extension repository.
-This will give some more control over where and how the extensions are distributed, but comes with the downside of requiring the `allow_unsigned_extensions`
-option to be set. For examples of how to configure a manual GitHub Actions deploy pipeline, check out the extension deploy script in https://github.com/duckdb/extension-ci-tools.
-Some examples of extensions that use this CI/CD workflow check out [spatial](https://github.com/duckdblabs/duckdb_spatial) or [aws](https://github.com/duckdb/duckdb_aws).
-
-Extensions in custom repositories can be installed and loaded using:
-```SQL
-INSTALL <my_extension> FROM 'http://my-custom-repo'
-LOAD <my_extension>
-```
-
-### Versioning of your extension
-Extension binaries will only work for the specific DuckDB version they were built for. The version of DuckDB that is targeted 
-is set to the latest stable release for the main branch of the template so initially that is all you need. As new releases 
-of DuckDB are published however, the extension repository will need to be updated. The template comes with a workflow set-up
-that will automatically build the binaries for all DuckDB target architectures that are available in the corresponding DuckDB
-version. This workflow is found in `.github/workflows/MainDistributionPipeline.yml`. It is up to the extension developer to keep
-this up to date with DuckDB. Note also that its possible to distribute binaries for multiple DuckDB versions in this workflow 
-by simply duplicating the jobs.
-
-## Setting up CLion 
-
-### Opening project
-Configuring CLion with the extension template requires a little work. Firstly, make sure that the DuckDB submodule is available. 
-Then make sure to open `./duckdb/CMakeLists.txt` (so not the top level `CMakeLists.txt` file from this repo) as a project in CLion.
-Now to fix your project path go to `tools->CMake->Change Project Root`([docs](https://www.jetbrains.com/help/clion/change-project-root-directory.html)) to set the project root to the root dir of this repo.
-
-### Debugging
-To set up debugging in CLion, there are two simple steps required. Firstly, in `CLion -> Settings / Preferences -> Build, Execution, Deploy -> CMake` you will need to add the desired builds (e.g. Debug, Release, RelDebug, etc). There's different ways to configure this, but the easiest is to leave all empty, except the `build path`, which needs to be set to `../build/{build type}`. Now on a clean repository you will first need to run `make {build type}` to initialize the CMake build directory. After running make, you will be able to (re)build from CLion by using the build target we just created. If you use the CLion editor, you can create a CLion CMake profiles matching the CMake variables that are described in the makefile, and then you don't need to invoke the Makefile.
+## Future Enhancements
+Planned features include:
+- Table functions for scanning Redis keys
+- Additional Redis commands (SADD, SMEMBERS, etc.)
+- Batch operations using Redis pipelines
+- Connection timeout handling
 
-The second step is to configure the unittest runner as a run/debug configuration. To do this, go to `Run -> Edit Configurations` and click `+ -> Cmake Application`. The target and executable should be `unittest`. This will run all the DuckDB tests. To specify only running the extension specific tests, add `--test-dir ../../.. [sql]` to the `Program Arguments`. Note that it is recommended to use the `unittest` executable for testing/development within CLion. The actual DuckDB CLI currently does not reliably work as a run target in CLion.

duckdb

@@ -1,6 +1,7 @@
 #pragma once
 
 #include "duckdb.hpp"
+#include "redis_secret.hpp"
 
 namespace duckdb {
 
@@ -10,4 +11,4 @@ class RedisExtension : public Extension {
     std::string Name() override;
 };
 
-} // namespace duckdb 
+} // namespace duckdb 

extension-ci-tools

@@ -0,0 +1,14 @@
+#pragma once
+
+#include "duckdb/main/secret/secret.hpp"
+#include "duckdb/main/secret/secret_manager.hpp"
+#include "duckdb/main/extension_util.hpp"
+
+namespace duckdb {
+
+class CreateRedisSecretFunctions {
+public:
+    static void Register(DatabaseInstance &instance);
+};
+
+} // namespace duckdb