Document endpoint use for private networking needs.#91
Open
James Robinson (jlrobins) wants to merge 1 commit intomainfrom
Open
Document endpoint use for private networking needs.#91James Robinson (jlrobins) wants to merge 1 commit intomainfrom
endpoint use for private networking needs.#91James Robinson (jlrobins) wants to merge 1 commit intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the project documentation to clarify how to use the endpoint parameter for Confluent Cloud Flink private networking scenarios, complementing the previously-added endpoint support in connect() / Connection.
Changes:
- Expand
endpointparameter docstrings to mention private networking and provide an example private endpoint URL. - Add a README section describing when and how to set
endpointfor private networking, plus common symptoms when it’s misconfigured.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/confluent_sql/connection.py | Improves endpoint parameter docstrings with private-networking guidance and an example URL. |
| README.md | Adds a “Private Networking Considerations” section explaining how to use endpoint and what misconfiguration looks like. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Symptoms of using the public endpoint when private networking is required include: | ||
| * HTTP 429-related exceptions raised when submitting statements querying tables whose backing Kafka topics / clusters are configured for private networking only. | ||
| * Empty or surpsingly missing results when querying `INFORMATION_SCHEMA` or `SHOW TABLES`, due to silent filtering of private-networking-only tables/topics when querying the system catalog. |
There was a problem hiding this comment.
Typo: "surpsingly" should be "surprisingly".
Suggested change
| * Empty or surpsingly missing results when querying `INFORMATION_SCHEMA` or `SHOW TABLES`, due to silent filtering of private-networking-only tables/topics when querying the system catalog. | |
| * Empty or surprisingly missing results when querying `INFORMATION_SCHEMA` or `SHOW TABLES`, due to silent filtering of private-networking-only tables/topics when querying the system catalog. |
| ## Private Networking Considerations | ||
|
|
||
| By default, this driver uses the public Confluent Cloud API networking endpoint for the provided cloud provider and region. However, if the Flink database / Kafka cluster you intend to query requires private networking connectivity, then provide the appropriate Flink private networking base URL as the `endpoint` parameter | ||
| to `connect()` or `Connection.__init__()`. Refer to the Confluent Cloud [Flink private networking documentation](https://docs.confluent.io/cloud/current/flink/concepts/flink-private-networking.html) for more information at composing your endpoint URL. |
There was a problem hiding this comment.
Grammar: "for more information at composing your endpoint URL" reads incorrect; consider "for more information on (or about) composing your endpoint URL".
Suggested change
| to `connect()` or `Connection.__init__()`. Refer to the Confluent Cloud [Flink private networking documentation](https://docs.confluent.io/cloud/current/flink/concepts/flink-private-networking.html) for more information at composing your endpoint URL. | |
| to `connect()` or `Connection.__init__()`. Refer to the Confluent Cloud [Flink private networking documentation](https://docs.confluent.io/cloud/current/flink/concepts/flink-private-networking.html) for more information on composing your endpoint URL. |
| slash is optional and will be stripped if provided (e.g., both | ||
| endpoint: The base URL for Confluent Cloud API (optional). If not provided, the public | ||
| networking endpoint will be constructed based on the cloud_provider and cloud_region | ||
| parameters ala "https://flink.{cloud_region}.{cloud_provider}.confluent.cloud". |
There was a problem hiding this comment.
Docstring wording: "parameters ala ..." is nonstandard English; consider changing to "in the format ..." or "like ..." for clarity.
Suggested change
| parameters ala "https://flink.{cloud_region}.{cloud_provider}.confluent.cloud". | |
| parameters in the format "https://flink.{cloud_region}.{cloud_provider}.confluent.cloud". |
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
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 #90