trinodb / trinodb/trino-python-client

Documentation for trino.dbapi.connect parameters

Open Beginner friendly
#583 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
439
Forks
206
PR merge metrics
No merged PRs in 30d

Description

The trino.dbapi.connect has no documentation on the connection parameters.

I recommend adding a table like the below for said parameters.

Parameter Type Default Description
host str 'localhost' The hostname or IP address of the Trino coordinator.
port int 8080 The port number of the Trino coordinator.
user str None The username for the session. Required if not using an auth method that supplies it.
catalog str None The default catalog to use for queries.
schema str None The default schema to use for queries.
auth object None An authentication instance (e.g., BasicAuthentication, KerberosAuthentication).
http_scheme str 'http' Protocol to use: 'http' or 'https'.
verify bool | str True Controls SSL verification. Set to False to disable, or provide a path to a CA bundle.
max_attempts int 3 Maximum number of retry attempts for HTTP requests.
request_timeout float None Client-side timeout (in seconds) for the HTTP request itself.
source str 'trino-python-client' The source name displayed in the Trino Web UI for queries.
session_properties dict None A dictionary of session properties (e.g., {'query_max_run_time': '10m'}).
http_headers dict None A dictionary of additional custom HTTP headers to send with requests.
client_tags list[str] None A list of tags to associate with the session/queries.
isolation_level int AUTOCOMMIT Transaction isolation level.
timezone str None The timezone for the session (e.g., 'US/Pacific').

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation entry point for trino.dbapi.connect and compare its documented signature with the connection parameters listed in the issue. Add a parameter table covering the requested types, defaults, and descriptions, then build the documentation to confirm the table renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.