D1

List

Returns a list of D1 databases.

$response = $client->d1()->list('ACCOUNT_ID', []);

Create

Create D1 Database

$client->d1()->create('ACCOUNT_ID', [
    'name' => 'my-database',
    'primary_location_hint' => 'weur',
]);

$response = $client->d1()->create('ACCOUNT_ID', []);

Get

Returns the specified D1 database.

$response = $client->d1()->get('ACCOUNT_ID', 'DATABASE_ID');

Delete

Deletes the specified D1 database.

$response = $client->d1()->delete('ACCOUNT_ID', 'DATABASE_ID');

Update

Updates the specified D1 database, overwriting the full configuration.

$client->d1()->update('ACCOUNT_ID', 'DATABASE_ID', [
    'read_replication' => ['mode' => 'auto'],
]);

$response = $client->d1()->update('ACCOUNT_ID', 'DATABASE_ID', []);

Edit

Applies changes to the specified D1 database, overwriting only the supplied properties.

$response = $client->d1()->edit('ACCOUNT_ID', 'DATABASE_ID', []);

Bookmark

Get a Time Travel bookmark for a D1 database.

Without a timestamp you get the current bookmark; with one, the nearest bookmark at or before it. Feed either into restore().

$response = $client->d1()->bookmark('ACCOUNT_ID', 'DATABASE_ID', 'TIMESTAMP');

Restore

Restore a D1 database to a previous point in time.

Give it exactly one of a bookmark or a timestamp — a bookmark from bookmark() names an exact point, a timestamp asks D1 to find the nearest one.

$bookmark = $client->d1()->bookmark('ACCOUNT_ID', 'DATABASE_ID')->json('result.bookmark');

$client->d1()->restore('ACCOUNT_ID', 'DATABASE_ID', bookmark: $bookmark);

$response = $client->d1()->restore('ACCOUNT_ID', 'DATABASE_ID', 'BOOKMARK', 'TIMESTAMP');

Export

Returns a URL where the SQL contents of your D1 can be downloaded. Note: this process may take some time for larger DBs, during which your D1 will be unavailable to serve queries. To avoid blocking your DB unnecessarily, an in-progress export must be continually polled or will automatically cancel.

$response = $client->d1()->export('ACCOUNT_ID', 'DATABASE_ID', 'CURRENT_BOOKMARK', true, true, []);

Import

Generates a temporary URL for uploading an SQL file to, then instructing the D1 to import it and polling it for status updates. Imports block the D1 for their duration.

$response = $client->d1()->import('ACCOUNT_ID', 'DATABASE_ID', 'ACTION', 'ETAG', 'FILENAME', 'CURRENT_BOOKMARK');

Query

Returns the query result as an object.

$response = $client->d1()->query('ACCOUNT_ID', 'DATABASE_ID', 'QUERY', []);

Raw

Returns the query result rows as arrays rather than objects. This is a performance-optimized version of the /query endpoint.

$response = $client->d1()->raw('ACCOUNT_ID', 'DATABASE_ID', 'QUERY', []);