docs(proxy): document proxy layer (proxy_connector, proxy_config)#357
Merged
Conversation
Document the database proxy layer including architecture overview, proxy_config.h parameters, proxy_connector.h API reference, usage examples with TLS/mTLS, backend integration details, and performance considerations. Update API_REFERENCE.md and ARCHITECTURE.md to include proxy layer references.
6 tasks
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
Document the database proxy layer including architecture overview, proxy_config.h parameters, proxy_connector.h API reference, usage examples with TLS/mTLS, backend integration details, and performance considerations. Update API_REFERENCE.md and ARCHITECTURE.md to include proxy layer references.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #353
Summary
docs/guides/PROXY_LAYER.mdcovering architecture, configuration, API reference, usage examples, backend integration, and performance considerationsdocs/API_REFERENCE.mdwith proxy mode API section (proxy_connection_config, proxy_connector, database_manager proxy API)docs/ARCHITECTURE.mdwith proxy layer in architecture diagram and backend implementations listChanges
New Files
docs/guides/PROXY_LAYER.md— Full proxy layer documentation with:proxy_connection_configparameters documented)proxy_connectorclass,proxy_stateenum, connection lifecycle)Modified Files
docs/API_REFERENCE.md— Added Proxy Mode section with config/connector/manager APIdocs/ARCHITECTURE.md— Updated architecture diagram to show direct/proxy split, added proxy_connector to backend list, documented connection modesTest Plan
cmake --buildpasses, 92% tests pass — 19 failures are pre-existing integration tests unrelated to docs)