mirror of
https://github.com/redis/go-redis.git
synced 2025-07-22 10:01:50 +03:00
70 lines
2.7 KiB
Markdown
70 lines
2.7 KiB
Markdown
# Redis Client Documentation
|
|
|
|
This documentation is AI-generated and provides a comprehensive overview of the Redis client implementation. The documentation is organized into several key files, each focusing on different aspects of the Redis client.
|
|
|
|
## Documentation Structure
|
|
|
|
### 1. General Architecture ([`general_architecture.md`](general_architecture.md))
|
|
- High-level architecture of the Redis client
|
|
- Core components and their interactions
|
|
- Connection management
|
|
- Command processing pipeline
|
|
- Error handling
|
|
- Monitoring and instrumentation
|
|
- Best practices and patterns
|
|
|
|
### 2. Connection Pool Implementation ([`redis_pool.md`](redis_pool.md))
|
|
- Detailed explanation of the connection pool system
|
|
- Pool configuration options
|
|
- Connection lifecycle management
|
|
- Pool statistics and monitoring
|
|
- Error handling in the pool
|
|
- Performance considerations
|
|
- Best practices for pool usage
|
|
|
|
### 3. Command Processing ([`redis_command_processing.md`](redis_command_processing.md))
|
|
- Command interface and implementation
|
|
- Command execution pipeline
|
|
- Different execution modes (single, pipeline, transaction)
|
|
- Command types and categories
|
|
- Error handling and retries
|
|
- Best practices for command usage
|
|
- Monitoring and debugging
|
|
|
|
### 4. Testing Framework ([`redis_testing.md`](redis_testing.md))
|
|
- Test environment setup using Docker
|
|
- Environment variables and configuration
|
|
- Running tests with Makefile commands
|
|
- Writing tests with Ginkgo and Gomega
|
|
- Test organization and patterns
|
|
- Coverage reporting
|
|
- Best practices for testing
|
|
|
|
### 5. Clients and Connections ([`clients-and-connections.md`](clients-and-connections.md))
|
|
- Detailed client types and their usage
|
|
- Connection management and configuration
|
|
- Client-specific features and optimizations
|
|
- Connection pooling strategies
|
|
- Best practices for client usage
|
|
|
|
## Important Notes
|
|
|
|
1. This documentation is AI-generated and should be reviewed for accuracy
|
|
2. The documentation is based on the actual codebase implementation
|
|
3. All examples and code snippets are verified against the source code
|
|
4. The documentation is regularly updated to reflect changes in the codebase
|
|
|
|
## Contributing
|
|
|
|
For detailed information about contributing to the project, please see the [Contributing Guide](../CONTRIBUTING.md) in the root directory.
|
|
|
|
If you find any inaccuracies or would like to suggest improvements to the documentation, please:
|
|
1. Review the actual code implementation
|
|
2. Submit a pull request with the proposed changes
|
|
3. Include references to the relevant code files
|
|
|
|
## Related Resources
|
|
|
|
- [Go Redis Client GitHub Repository](https://github.com/redis/go-redis)
|
|
- [Redis Official Documentation](https://redis.io/documentation)
|
|
- [Go Documentation](https://golang.org/doc/) |