GitHub

D1ClientConfig

API reference for D1ClientConfig.

Which database, and what the client does with rows and names.

  • account_id / database_id: the database's account and its id (wrangler d1 info)
  • api_token: a Cloudflare API token allowed to edit D1
  • base_url: the API's root (Cloudflare's by default)
  • span_attributes: added to every statement's span
  • transform_result_names / transform_query_names: rename result columns / identifiers (fx.case has the usual ones)

Attributes

AttributeTypeDescription
account_idstr
database_idstr
api_tokenRedacted[str]
base_urlstr = DEFAULT_BASE_URL
span_attributesMapping[str, object] = field(default_factory=(dict[str, object]))
transform_result_namesCallable[[str], str] | None = None
transform_query_namesCallable[[str], str] | None = None
database_urlstr

The database's endpoint, to which /query and /raw are appended.

Functions

__init__

__init__(*, account_id, database_id, api_token, base_url=DEFAULT_BASE_URL, span_attributes=dict[str, object](), transform_result_names=None, transform_query_names=None) -> None
ParameterTypeDescription
account_idstr
database_idstr
api_tokenRedacted[str]
base_urlstr = DEFAULT_BASE_URL
span_attributesMapping[str, object] = dict[str, object]()
transform_result_namesCallable[[str], str] | None = None
transform_query_namesCallable[[str], str] | None = None