Query D1 Database

client.d1.database.query(, , ?): SinglePage<QueryResult { meta, results, success } >

POST/accounts/{account_id}/d1/database/{database_id}/query

Returns the query result as an object.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

D1 ReadD1 Write

ParametersExpand Collapse

databaseId: string

D1 database identifier (UUID).

DatabaseQueryParams = D1SingleQuery | MultipleQueries

DatabaseQueryParamsBase

D1SingleQuery extends DatabaseQueryParamsBase

MultipleQueries extends DatabaseQueryParamsBase

ReturnsExpand Collapse

QueryResult { meta, results, success }

meta?: Meta { changed_db, changes, duration, 8 more }

changed_db?: boolean

Denotes if the database has been altered in some way, like deleting rows.

changes?: number

Rough indication of how many rows were modified by the query, as provided by SQLite's sqlite3_total_changes().

duration?: number

The duration of the SQL query execution inside the database. Does not include any network communication.

last_row_id?: number

The row ID of the last inserted row in a table with an INTEGER PRIMARY KEY as provided by SQLite. Tables created with WITHOUT ROWID do not populate this.

rows_read?: number

Number of rows read during the SQL query execution, including indices (not all rows are necessarily returned).

rows_written?: number

Number of rows written during the SQL query execution, including indices.

served_by_colo?: string

The three letters airport code of the colo that handled the query.

served_by_primary?: boolean

Denotes if the query has been handled by the database primary instance.

served_by_region?: "WNAM" | "ENAM" | "WEUR" | 3 more

Region location hint of the database instance that handled the query.

One of the following:

"WNAM"

"ENAM"

"WEUR"

"EEUR"

"APAC"

"OC"

size_after?: number

Size of the database after the query committed, in bytes.

timings?: Timings { sql_duration_ms }

Various durations for the query.

sql_duration_ms?: number

The duration of the SQL query execution inside the database. Does not include any network communication.

results?: Array<unknown>

success?: boolean

Query D1 Database

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const queryResult of client.d1.database.query('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  sql: 'SELECT * FROM myTable WHERE field = ? OR field = ?;',
})) {
  console.log(queryResult.meta);
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "meta": {
        "changed_db": true,
        "changes": 0,
        "duration": 0,
        "last_row_id": 0,
        "rows_read": 0,
        "rows_written": 0,
        "served_by_colo": "LHR",
        "served_by_primary": true,
        "served_by_region": "EEUR",
        "size_after": 0,
        "timings": {
          "sql_duration_ms": 0
        }
      },
      "results": [
        {}
      ],
      "success": true
    }
  ],
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "meta": {
        "changed_db": true,
        "changes": 0,
        "duration": 0,
        "last_row_id": 0,
        "rows_read": 0,
        "rows_written": 0,
        "served_by_colo": "LHR",
        "served_by_primary": true,
        "served_by_region": "EEUR",
        "size_after": 0,
        "timings": {
          "sql_duration_ms": 0
        }
      },
      "results": [
        {}
      ],
      "success": true
    }
  ],
  "success": true
}