Skip to content

Commit f66d339

Browse files
authored
Update README.md
Removed the examples of features that are not supported yet
1 parent c63e981 commit f66d339

File tree

1 file changed

+10
-46
lines changed

1 file changed

+10
-46
lines changed

README.md

Lines changed: 10 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ Valkey General Language Independent Driver for the Enterprise (GLIDE) is the off
2424
- **[Sharded PubSub](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#pubsub-support:~:text=Receiving%2C%20and%20Unsubscribing.-,Subscribing,routed%20to%20the%20server%20holding%20the%20slot%20for%20the%20command%27s%20channel.,-Receiving)** – Native support for sharded PubSub across cluster slots.
2525
- **[Cluster-Aware MGET/MSET/DEL/FLUSHALL](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#multi-slot-command-handling:~:text=Multi%2DSlot%20Command%20Execution,JSON.MGET)** – Execute multi-key commands across cluster slots without manual key grouping.
2626
- **[Cluster Scan](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#cluster-scan)** – Unified key iteration across shards using a consistent, high-level API for cluster environments.
27-
- **Support for TS / CJS / MJS** – Fully compatible with modern and legacy JavaScript/TypeScript runtimes.
28-
- **Support for asyncio / anyio / trio** – Native compatibility with modern Python async frameworks, enabling efficient and seamless integration into asynchronous workflows.
2927
- **[Batching (Pipeline and Transaction)](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#batching-pipeline-and-transaction)** – Efficiently execute multiple commands in a single network roundtrip, significantly reducing latency and improving throughput.
3028
- **[OpenTelemetry](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#opentelemetry)** – Integrated tracing support for enhanced observability and easier debugging in distributed environments.
3129

@@ -175,11 +173,11 @@ try {
175173
176174
// Create ValkeyGlide client
177175
$client = new ValkeyGlide(
178-
$addresses, // addresses
179-
false, // use_tls
180-
null, // credentials
181-
0, // read_from (PRIMARY)
182-
500 // request_timeout (500ms)
176+
$addresses, // addresses
177+
false, // use_tls
178+
null, // credentials
179+
ValkeyGlide::READ_FROM_PRIMARY, // read_from (PRIMARY)
180+
500 // request_timeout (500ms)
183181
);
184182
185183
// Basic operations
@@ -215,11 +213,11 @@ try {
215213
216214
// Create ValkeyGlideCluster client
217215
$client = new ValkeyGlideCluster(
218-
$addresses, // addresses
219-
false, // use_tls
220-
null, // credentials
221-
0, // read_from (PRIMARY)
222-
500 // request_timeout (500ms)
216+
$addresses, // addresses
217+
false, // use_tls
218+
null, // credentials
219+
ValkeyGlide::READ_FROM_PRIMARY, // read_from (PRIMARY)
220+
500 // request_timeout (500ms)
223221
);
224222
225223
// Basic operations
@@ -241,40 +239,6 @@ try {
241239
?>
242240
```
243241

244-
### Configuration Options
245-
246-
The Valkey GLIDE PHP extension supports various configuration options:
247-
248-
```php
249-
<?php
250-
// Advanced configuration example
251-
$client = new ValkeyGlide(
252-
$addresses, // Required: Array of server addresses
253-
true, // use_tls: Enable TLS encryption
254-
[ // credentials: Authentication credentials
255-
'username' => 'myuser',
256-
'password' => 'mypass'
257-
],
258-
1, // read_from: 0=PRIMARY, 1=PREFER_REPLICA, 2=AZ_AFFINITY
259-
1000, // request_timeout: Request timeout in milliseconds
260-
[ // reconnect_strategy: Backoff strategy for reconnections
261-
'num_of_retries' => 3,
262-
'factor' => 2.0,
263-
'exponent_base' => 2
264-
],
265-
0, // database_id: Database number (0-15 for standalone)
266-
'my-client', // client_name: Client identifier
267-
250, // inflight_requests_limit: Max concurrent requests
268-
'us-east-1a', // client_az: Client availability zone
269-
[ // advanced_config: Advanced configuration options
270-
'connection_timeout' => 5000,
271-
'tls_config' => ['use_insecure_tls' => false]
272-
],
273-
false // lazy_connect: Whether to connect lazily
274-
);
275-
?>
276-
```
277-
278242
### Contributing
279243

280244
All contributions are automatically validated through our CI pipeline, ensuring:

0 commit comments

Comments
 (0)