--- title: Database --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [D1](https://developers.cloudflare.com/api/typescript/resources/d1) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Database ##### [List D1 Databases](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/methods/list) client.d1.database.list(DatabaseListParams {account\_id, name, page, per\_page } params, RequestOptionsoptions?): V4PagePaginationArray< [DatabaseListResponse]() {created\_at, jurisdiction, name, 2 more } > GET/accounts/{account\_id}/d1/database ##### [Get D1 Database](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/methods/get) client.d1.database.get(stringdatabaseID, DatabaseGetParams {account\_id, fields } params, RequestOptionsoptions?): [D1]() {created\_at, file\_size, jurisdiction, 5 more } GET/accounts/{account\_id}/d1/database/{database\_id} ##### [Create D1 Database](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/methods/create) client.d1.database.create(DatabaseCreateParams {account\_id, name, jurisdiction, 2 more } params, RequestOptionsoptions?): [D1]() {created\_at, file\_size, jurisdiction, 5 more } POST/accounts/{account\_id}/d1/database ##### [Update D1 Database](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/methods/update) client.d1.database.update(stringdatabaseID, DatabaseUpdateParams {account\_id, read\_replication } params, RequestOptionsoptions?): [D1]() {created\_at, file\_size, jurisdiction, 5 more } PUT/accounts/{account\_id}/d1/database/{database\_id} ##### [Update D1 Database partially](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/methods/edit) client.d1.database.edit(stringdatabaseID, DatabaseEditParams {account\_id, read\_replication } params, RequestOptionsoptions?): [D1]() {created\_at, file\_size, jurisdiction, 5 more } PATCH/accounts/{account\_id}/d1/database/{database\_id} ##### [Delete D1 Database](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/methods/delete) client.d1.database.delete(stringdatabaseID, DatabaseDeleteParams {account\_id } params, RequestOptionsoptions?): [DatabaseDeleteResponse]()| null DELETE/accounts/{account\_id}/d1/database/{database\_id} ##### [Query D1 Database](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/methods/query) client.d1.database.query(stringdatabaseID, DatabaseQueryParamsparams, RequestOptionsoptions?): SinglePage< [QueryResult]() {meta, results, success } > POST/accounts/{account\_id}/d1/database/{database\_id}/query ##### [Raw D1 Database query](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/methods/raw) client.d1.database.raw(stringdatabaseID, DatabaseRawParamsparams, RequestOptionsoptions?): SinglePage< [DatabaseRawResponse]() {meta, results, success } > POST/accounts/{account\_id}/d1/database/{database\_id}/raw ##### [Export D1 Database as SQL](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/methods/export) client.d1.database.export(stringdatabaseID, DatabaseExportParams {account\_id, output\_format, current\_bookmark, dump\_options } params, RequestOptionsoptions?): [DatabaseExportResponse]() {at\_bookmark, error, messages, 4 more } POST/accounts/{account\_id}/d1/database/{database\_id}/export ##### [Import SQL into your D1 Database](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/methods/import) client.d1.database.import(stringdatabaseID, DatabaseImportParamsparams, RequestOptionsoptions?): [DatabaseImportResponse]() {at\_bookmark, error, filename, 6 more } POST/accounts/{account\_id}/d1/database/{database\_id}/import ##### ModelsExpand 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. Link to this property changes?: number Rough indication of how many rows were modified by the query, as provided by SQLite’s sqlite3_total_changes(). Link to this property duration?: number The duration of the SQL query execution inside the database. Does not include any network communication. Link to this property 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. Link to this property rows\_read?: number Number of rows read during the SQL query execution, including indices (not all rows are necessarily returned). Link to this property rows\_written?: number Number of rows written during the SQL query execution, including indices. Link to this property served\_by\_colo?: string The three letters airport code of the colo that handled the query. Link to this property served\_by\_primary?: boolean Denotes if the query has been handled by the database primary instance. Link to this property
served\_by\_region?: "WNAM"| "ENAM"| "WEUR"| 3 more Region location hint of the database instance that handled the query. One of the following: "WNAM" Link to this property "ENAM" Link to this property "WEUR" Link to this property "EEUR" Link to this property "APAC" Link to this property "OC" Link to this property
Link to this property size\_after?: number Size of the database after the query committed, in bytes. Link to this property
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. Link to this property
Link to this property
Link to this property results?: Array<unknown> Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20d1.database%20%3E%20(model)%20query_result%20%3E%20(schema)>)
DatabaseListResponse {created\_at, jurisdiction, name, 2 more } created\_at?: string Specifies the timestamp the resource was created as an ISO8601 string. formatdate-time Link to this property
jurisdiction?: "eu"| "fedramp"| "us"| null Specify the location to restrict the D1 database to run and store data. If this option is present, the location hint is ignored. One of the following: "eu" Link to this property "fedramp" Link to this property "us" Link to this property
Link to this property name?: string D1 database name. Link to this property uuid?: string D1 database identifier (UUID). Link to this property version?: string Link to this property
[Link to this property](<#(resource)%20d1.database%20%3E%20(model)%20database_list_response%20%3E%20(schema)>) DatabaseDeleteResponse = unknown [Link to this property](<#(resource)%20d1.database%20%3E%20(model)%20database_delete_response%20%3E%20(schema)>)
DatabaseRawResponse {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. Link to this property changes?: number Rough indication of how many rows were modified by the query, as provided by SQLite’s sqlite3_total_changes(). Link to this property duration?: number The duration of the SQL query execution inside the database. Does not include any network communication. Link to this property 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. Link to this property rows\_read?: number Number of rows read during the SQL query execution, including indices (not all rows are necessarily returned). Link to this property rows\_written?: number Number of rows written during the SQL query execution, including indices. Link to this property served\_by\_colo?: string The three letters airport code of the colo that handled the query. Link to this property served\_by\_primary?: boolean Denotes if the query has been handled by the database primary instance. Link to this property
served\_by\_region?: "WNAM"| "ENAM"| "WEUR"| 3 more Region location hint of the database instance that handled the query. One of the following: "WNAM" Link to this property "ENAM" Link to this property "WEUR" Link to this property "EEUR" Link to this property "APAC" Link to this property "OC" Link to this property
Link to this property size\_after?: number Size of the database after the query committed, in bytes. Link to this property
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. Link to this property
Link to this property
Link to this property
results?: Results {columns, rows } columns?: Array<string> Link to this property
rows?: Array<Array<number| string| unknown>> One of the following: number Link to this property string Link to this property unknown Link to this property
Link to this property
Link to this property success?: boolean Link to this property
[Link to this property](<#(resource)%20d1.database%20%3E%20(model)%20database_raw_response%20%3E%20(schema)>)
DatabaseExportResponse {at\_bookmark, error, messages, 4 more } at\_bookmark?: string The current time-travel bookmark for your D1, used to poll for updates. Will not change for the duration of the export task. Link to this property error?: string Only present when status = ‘error’. Contains the error message. Link to this property messages?: Array<string> Logs since the last time you polled Link to this property
result?: Result {filename, signed\_url } Only present when status = ‘complete’ filename?: string The generated SQL filename. Link to this property signed\_url?: string The URL to download the exported SQL. Available for one hour. Link to this property
Link to this property
status?: "complete"| "error" One of the following: "complete" Link to this property "error" Link to this property
Link to this property success?: boolean Link to this property type?: "export" Link to this property
[Link to this property](<#(resource)%20d1.database%20%3E%20(model)%20database_export_response%20%3E%20(schema)>)
DatabaseImportResponse {at\_bookmark, error, filename, 6 more } at\_bookmark?: string The current time-travel bookmark for your D1, used to poll for updates. Will not change for the duration of the import. Only returned if an import process is currently running or recently finished. Link to this property error?: string Only present when status = ‘error’. Contains the error message that prevented the import from succeeding. Link to this property filename?: string Derived from the database ID and etag, to use in avoiding repeated uploads. Only returned when for the ‘init’ action. Link to this property messages?: Array<string> Logs since the last time you polled Link to this property
result?: Result {final\_bookmark, meta, num\_queries } Only present when status = ‘complete’ final\_bookmark?: string The time-travel bookmark if you need restore your D1 to directly after the import succeeded. Link to this property
meta?: Meta {changed\_db, changes, duration, 8 more } changed\_db?: boolean Denotes if the database has been altered in some way, like deleting rows. Link to this property changes?: number Rough indication of how many rows were modified by the query, as provided by SQLite’s sqlite3_total_changes(). Link to this property duration?: number The duration of the SQL query execution inside the database. Does not include any network communication. Link to this property 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. Link to this property rows\_read?: number Number of rows read during the SQL query execution, including indices (not all rows are necessarily returned). Link to this property rows\_written?: number Number of rows written during the SQL query execution, including indices. Link to this property served\_by\_colo?: string The three letters airport code of the colo that handled the query. Link to this property served\_by\_primary?: boolean Denotes if the query has been handled by the database primary instance. Link to this property
served\_by\_region?: "WNAM"| "ENAM"| "WEUR"| 3 more Region location hint of the database instance that handled the query. One of the following: "WNAM" Link to this property "ENAM" Link to this property "WEUR" Link to this property "EEUR" Link to this property "APAC" Link to this property "OC" Link to this property
Link to this property size\_after?: number Size of the database after the query committed, in bytes. Link to this property
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. Link to this property
Link to this property
Link to this property num\_queries?: number The total number of queries that were executed during the import. Link to this property
Link to this property
status?: "complete"| "error" One of the following: "complete" Link to this property "error" Link to this property
Link to this property success?: boolean Link to this property type?: "import" Link to this property upload\_url?: string The R2 presigned URL to use for uploading. Only returned when for the ‘init’ action. Link to this property
[Link to this property](<#(resource)%20d1.database%20%3E%20(model)%20database_import_response%20%3E%20(schema)>) #### DatabaseTime Travel ##### [Get D1 database bookmark](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/subresources/time_travel/methods/get_bookmark) client.d1.database.timeTravel.getBookmark(stringdatabaseID, TimeTravelGetBookmarkParams {account\_id, timestamp } params, RequestOptionsoptions?): [TimeTravelGetBookmarkResponse]() {bookmark } GET/accounts/{account\_id}/d1/database/{database\_id}/time\_travel/bookmark ##### [Restore D1 Database to a bookmark or point in time](https://developers.cloudflare.com/api/typescript/resources/d1/subresources/database/subresources/time_travel/methods/restore) client.d1.database.timeTravel.restore(stringdatabaseID, TimeTravelRestoreParams {account\_id, bookmark, timestamp } params, RequestOptionsoptions?): [TimeTravelRestoreResponse]() {bookmark, message, previous\_bookmark } POST/accounts/{account\_id}/d1/database/{database\_id}/time\_travel/restore ##### ModelsExpand Collapse
TimeTravelGetBookmarkResponse {bookmark } bookmark?: string A bookmark representing a specific state of the database at a specific point in time. Link to this property
[Link to this property](<#(resource)%20d1.database.time_travel%20%3E%20(model)%20time_travel_get_bookmark_response%20%3E%20(schema)>)
TimeTravelRestoreResponse {bookmark, message, previous\_bookmark } Response from a time travel restore operation. bookmark?: string The new bookmark representing the state of the database after the restore operation. Link to this property message?: string A message describing the result of the restore operation. Link to this property previous\_bookmark?: string The bookmark representing the state of the database before the restore operation. Can be used to undo the restore if needed. Link to this property
[Link to this property](<#(resource)%20d1.database.time_travel%20%3E%20(model)%20time_travel_restore_response%20%3E%20(schema)>)