Valkey GLIDE Sync Client

Warnings

• breaking In version 2.1, the Python package structure underwent a significant change. Previously, core components might have been accessible directly under `glide`. Now, synchronous client classes are specifically under `glide_sync`, and shared components are under `glide_shared`. This change can break existing imports if not updated.
  Fix: Update import statements from `from glide import ...` to `from glide_sync import ...` for synchronous client components.
• gotcha Valkey GLIDE offers both synchronous (`valkey-glide-sync`) and asynchronous (`valkey-glide`) Python clients. Ensure you install and import from the correct package (`glide_sync` for sync, `glide` for async) based on your application's concurrency model. Mixing them or using the wrong package can lead to unexpected behavior or `AttributeError`s.
  Fix: Always use `pip install valkey-glide-sync` and `from glide_sync import ...` for synchronous operations, or `pip install valkey-glide` and `from glide import ...` for asynchronous operations.
• gotcha When executing commands with the synchronous client, the methods return a future-like object. You must explicitly call `.get()` on the result of a command (e.g., `client.ping().get()`) to retrieve the actual value or wait for completion. Failing to do so will result in an unawaited future object.
  Fix: Append `.get()` to all command calls to synchronously retrieve their results, e.g., `value = client.get('key').get()`.
• gotcha For cluster deployments, you must use `GlideClusterClient` and `GlideClusterClientConfiguration`. For standalone deployments, use `GlideClient` and `GlideClientConfiguration`. Using the wrong client type for your Redis/Valkey setup will result in connection or command execution errors.
  Fix: Instantiate `GlideClient` for standalone servers and `GlideClusterClient` for cluster environments, ensuring the configuration matches the deployment type.
• gotcha OpenTelemetry configuration can only be initialized once per process. If you need to change OpenTelemetry settings, your application must be restarted to apply the new configuration.
  Fix: Design your application to initialize OpenTelemetry tracing and metrics once at startup. For configuration changes, a process restart is required.

Install

• pip install valkey-glide-sync Install stable version

Imports

• GlideClient

  from glide_sync import GlideClient

  The `glide` package is for the asynchronous client. The synchronous client classes are in `glide_sync`.
• GlideClusterClient

  from glide_sync import GlideClusterClient

  The `glide` package is for the asynchronous client. The synchronous client classes are in `glide_sync`.
• GlideClientConfiguration

  from glide_sync import GlideClientConfiguration

• NodeAddress

  from glide_sync import NodeAddress

Quickstart

This quickstart demonstrates how to connect to a standalone Valkey or Redis OSS instance using the synchronous Glide client, perform a simple PING, SET, and GET operation, and then close the client. It uses environment variables for host and port, falling back to localhost:6379 for local testing. Remember to use `.get()` to retrieve results from the synchronous client's future-like return values.

import os
from glide_sync import GlideClient, GlideClientConfiguration, NodeAddress

# Configure connection details (e.g., from environment variables)
HOST = os.environ.get('GLIDE_HOST', 'localhost')
PORT = int(os.environ.get('GLIDE_PORT', '6379'))
PASSWORD = os.environ.get('GLIDE_PASSWORD', '') # Optional

# For Standalone client
config = GlideClientConfiguration(
    addresses=[NodeAddress(host=HOST, port=PORT)],
    password=PASSWORD if PASSWORD else None # Set password only if provided
)

# Create and connect the client (sync method)
try:
    client = GlideClient.create(config).get()
    response = client.ping().get()
    print(f"Ping response: {response}")
    
    client.set('mykey', 'myvalue').get()
    value = client.get('mykey').get()
    print(f"Retrieved value for 'mykey': {value}")
    
except Exception as e:
    print(f"An error occurred: {e}")
finally:
    if 'client' in locals() and client:
        client.close()