GitHub

API reference for D1Api.

D1's HTTP API for one database.

Attributes

AttributeTypeDescription
http_client= http_client
database_url= database_url
api_token= api_token

Functions

__init__

__init__(http_client, database_url, api_token) -> None
ParameterTypeDescription
http_clientHttpClientService[Any]
database_urlstr
api_tokenRedacted[str]
def __init__(
    self, http_client: HttpClientService[Any], database_url: str, api_token: Redacted[str]
) -> None:
    self.http_client = http_client
    self.database_url = database_url
    self.api_token = api_token

query

query(queries) -> Effect[list[D1Result], D1ApiError | HttpClientError]

Run queries (one, or a batch in one transaction); rows as objects, one result per statement.

ParameterTypeDescription
queriesSequence[Query]

Returns Effect[list[D1Result], D1ApiError | HttpClientError]

def query(
    self, queries: Sequence[Query]
) -> Effect[list[D1Result], D1ApiError | HttpClientError]:
    """Run ``queries`` (one, or a batch in one transaction); rows as
    objects, one result per statement."""
    return self._post("query", queries, _rows)

raw

raw(queries) -> Effect[list[D1RawResult], D1ApiError | HttpClientError]

query with rows as arrays of values.

ParameterTypeDescription
queriesSequence[Query]

Returns Effect[list[D1RawResult], D1ApiError | HttpClientError]

def raw(
    self, queries: Sequence[Query]
) -> Effect[list[D1RawResult], D1ApiError | HttpClientError]:
    """``query`` with rows as arrays of values."""
    return self._post("raw", queries, _raw_rows)