Skip to content

Commit 3b1ad4f

Browse files
author
OpenAPI Publisher Production
committed
Update schema
Stainless-Generated-From: f6c4d594c7c74d631a41109f5fea295eb35eb5d4
1 parent b899dca commit 3b1ad4f

33 files changed

Lines changed: 1483 additions & 179 deletions

‎.stats.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
configured_endpoints: 2653
1+
configured_endpoints: 2655

‎scripts/mock‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎src/cloudflare/resources/d1/database/database.py‎

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ def create(
8989
timeout: float | httpx.Timeout | None | NotGiven = not_given,
9090
) -> D1:
9191
"""
92-
Returns the created D1 database.
92+
Create a new D1 database in your account.
9393
9494
Args:
9595
account_id: Account identifier tag.
@@ -149,7 +149,7 @@ def update(
149149
timeout: float | httpx.Timeout | None | NotGiven = not_given,
150150
) -> D1:
151151
"""
152-
Updates the specified D1 database.
152+
Update a D1 database's configuration.
153153
154154
Args:
155155
account_id: Account identifier tag.
@@ -200,7 +200,7 @@ def list(
200200
timeout: float | httpx.Timeout | None | NotGiven = not_given,
201201
) -> SyncV4PagePaginationArray[DatabaseListResponse]:
202202
"""
203-
Returns a list of D1 databases.
203+
List D1 databases in your account.
204204
205205
Args:
206206
account_id: Account identifier tag.
@@ -254,7 +254,7 @@ def delete(
254254
timeout: float | httpx.Timeout | None | NotGiven = not_given,
255255
) -> object:
256256
"""
257-
Deletes the specified D1 database.
257+
Delete a D1 database.
258258
259259
Args:
260260
account_id: Account identifier tag.
@@ -301,7 +301,7 @@ def edit(
301301
timeout: float | httpx.Timeout | None | NotGiven = not_given,
302302
) -> D1:
303303
"""
304-
Updates partially the specified D1 database.
304+
Partially update a D1 database's configuration.
305305
306306
Args:
307307
account_id: Account identifier tag.
@@ -352,12 +352,12 @@ def export(
352352
extra_body: Body | None = None,
353353
timeout: float | httpx.Timeout | None | NotGiven = not_given,
354354
) -> DatabaseExportResponse:
355-
"""Returns a URL where the SQL contents of your D1 can be downloaded.
356-
357-
Note: this
358-
process may take some time for larger DBs, during which your D1 will be
359-
unavailable to serve queries. To avoid blocking your DB unnecessarily, an
360-
in-progress export must be continually polled or will automatically cancel.
355+
"""
356+
Export the SQL contents of a D1 database and return a URL where they can be
357+
downloaded. Note: this process may take some time for larger DBs, during which
358+
your D1 will be unavailable to serve queries. To avoid blocking your DB
359+
unnecessarily, an in-progress export must be continually polled or will
360+
automatically cancel.
361361
362362
Args:
363363
account_id: Account identifier tag.
@@ -432,7 +432,7 @@ def get(
432432
timeout: float | httpx.Timeout | None | NotGiven = not_given,
433433
) -> D1:
434434
"""
435-
Returns the specified D1 database.
435+
Get details for a specific D1 database.
436436
437437
Args:
438438
account_id: Account identifier tag.
@@ -485,8 +485,8 @@ def import_(
485485
timeout: float | httpx.Timeout | None | NotGiven = not_given,
486486
) -> DatabaseImportResponse:
487487
"""
488-
Generates a temporary URL for uploading an SQL file to, then instructing the D1
489-
to import it and polling it for status updates. Imports block the D1 for their
488+
Generate a temporary URL for uploading an SQL file to, then instruct the D1 to
489+
import it and poll it for status updates. Imports block the D1 for their
490490
duration.
491491
492492
Args:
@@ -527,8 +527,8 @@ def import_(
527527
timeout: float | httpx.Timeout | None | NotGiven = not_given,
528528
) -> DatabaseImportResponse:
529529
"""
530-
Generates a temporary URL for uploading an SQL file to, then instructing the D1
531-
to import it and polling it for status updates. Imports block the D1 for their
530+
Generate a temporary URL for uploading an SQL file to, then instruct the D1 to
531+
import it and poll it for status updates. Imports block the D1 for their
532532
duration.
533533
534534
Args:
@@ -569,8 +569,8 @@ def import_(
569569
timeout: float | httpx.Timeout | None | NotGiven = not_given,
570570
) -> DatabaseImportResponse:
571571
"""
572-
Generates a temporary URL for uploading an SQL file to, then instructing the D1
573-
to import it and polling it for status updates. Imports block the D1 for their
572+
Generate a temporary URL for uploading an SQL file to, then instruct the D1 to
573+
import it and poll it for status updates. Imports block the D1 for their
574574
duration.
575575
576576
Args:
@@ -658,7 +658,7 @@ def query(
658658
timeout: float | httpx.Timeout | None | NotGiven = not_given,
659659
) -> SyncSinglePage[QueryResult]:
660660
"""
661-
Returns the query result as an object.
661+
Execute a SQL query against a D1 database and return results as objects.
662662
663663
Args:
664664
account_id: Account identifier tag.
@@ -693,7 +693,7 @@ def query(
693693
timeout: float | httpx.Timeout | None | NotGiven = not_given,
694694
) -> SyncSinglePage[QueryResult]:
695695
"""
696-
Returns the query result as an object.
696+
Execute a SQL query against a D1 database and return results as objects.
697697
698698
Args:
699699
account_id: Account identifier tag.
@@ -765,10 +765,10 @@ def raw(
765765
extra_body: Body | None = None,
766766
timeout: float | httpx.Timeout | None | NotGiven = not_given,
767767
) -> SyncSinglePage[DatabaseRawResponse]:
768-
"""Returns the query result rows as arrays rather than objects.
769-
770-
This is a
771-
performance-optimized version of the /query endpoint.
768+
"""
769+
Execute a SQL query against a D1 database and return result rows as arrays
770+
rather than objects. This is a performance-optimized version of the /query
771+
endpoint.
772772
773773
Args:
774774
account_id: Account identifier tag.
@@ -802,10 +802,10 @@ def raw(
802802
extra_body: Body | None = None,
803803
timeout: float | httpx.Timeout | None | NotGiven = not_given,
804804
) -> SyncSinglePage[DatabaseRawResponse]:
805-
"""Returns the query result rows as arrays rather than objects.
806-
807-
This is a
808-
performance-optimized version of the /query endpoint.
805+
"""
806+
Execute a SQL query against a D1 database and return result rows as arrays
807+
rather than objects. This is a performance-optimized version of the /query
808+
endpoint.
809809
810810
Args:
811811
account_id: Account identifier tag.
@@ -903,7 +903,7 @@ async def create(
903903
timeout: float | httpx.Timeout | None | NotGiven = not_given,
904904
) -> D1:
905905
"""
906-
Returns the created D1 database.
906+
Create a new D1 database in your account.
907907
908908
Args:
909909
account_id: Account identifier tag.
@@ -963,7 +963,7 @@ async def update(
963963
timeout: float | httpx.Timeout | None | NotGiven = not_given,
964964
) -> D1:
965965
"""
966-
Updates the specified D1 database.
966+
Update a D1 database's configuration.
967967
968968
Args:
969969
account_id: Account identifier tag.
@@ -1016,7 +1016,7 @@ def list(
10161016
timeout: float | httpx.Timeout | None | NotGiven = not_given,
10171017
) -> AsyncPaginator[DatabaseListResponse, AsyncV4PagePaginationArray[DatabaseListResponse]]:
10181018
"""
1019-
Returns a list of D1 databases.
1019+
List D1 databases in your account.
10201020
10211021
Args:
10221022
account_id: Account identifier tag.
@@ -1070,7 +1070,7 @@ async def delete(
10701070
timeout: float | httpx.Timeout | None | NotGiven = not_given,
10711071
) -> object:
10721072
"""
1073-
Deletes the specified D1 database.
1073+
Delete a D1 database.
10741074
10751075
Args:
10761076
account_id: Account identifier tag.
@@ -1117,7 +1117,7 @@ async def edit(
11171117
timeout: float | httpx.Timeout | None | NotGiven = not_given,
11181118
) -> D1:
11191119
"""
1120-
Updates partially the specified D1 database.
1120+
Partially update a D1 database's configuration.
11211121
11221122
Args:
11231123
account_id: Account identifier tag.
@@ -1170,12 +1170,12 @@ async def export(
11701170
extra_body: Body | None = None,
11711171
timeout: float | httpx.Timeout | None | NotGiven = not_given,
11721172
) -> DatabaseExportResponse:
1173-
"""Returns a URL where the SQL contents of your D1 can be downloaded.
1174-
1175-
Note: this
1176-
process may take some time for larger DBs, during which your D1 will be
1177-
unavailable to serve queries. To avoid blocking your DB unnecessarily, an
1178-
in-progress export must be continually polled or will automatically cancel.
1173+
"""
1174+
Export the SQL contents of a D1 database and return a URL where they can be
1175+
downloaded. Note: this process may take some time for larger DBs, during which
1176+
your D1 will be unavailable to serve queries. To avoid blocking your DB
1177+
unnecessarily, an in-progress export must be continually polled or will
1178+
automatically cancel.
11791179
11801180
Args:
11811181
account_id: Account identifier tag.
@@ -1250,7 +1250,7 @@ async def get(
12501250
timeout: float | httpx.Timeout | None | NotGiven = not_given,
12511251
) -> D1:
12521252
"""
1253-
Returns the specified D1 database.
1253+
Get details for a specific D1 database.
12541254
12551255
Args:
12561256
account_id: Account identifier tag.
@@ -1303,8 +1303,8 @@ async def import_(
13031303
timeout: float | httpx.Timeout | None | NotGiven = not_given,
13041304
) -> DatabaseImportResponse:
13051305
"""
1306-
Generates a temporary URL for uploading an SQL file to, then instructing the D1
1307-
to import it and polling it for status updates. Imports block the D1 for their
1306+
Generate a temporary URL for uploading an SQL file to, then instruct the D1 to
1307+
import it and poll it for status updates. Imports block the D1 for their
13081308
duration.
13091309
13101310
Args:
@@ -1345,8 +1345,8 @@ async def import_(
13451345
timeout: float | httpx.Timeout | None | NotGiven = not_given,
13461346
) -> DatabaseImportResponse:
13471347
"""
1348-
Generates a temporary URL for uploading an SQL file to, then instructing the D1
1349-
to import it and polling it for status updates. Imports block the D1 for their
1348+
Generate a temporary URL for uploading an SQL file to, then instruct the D1 to
1349+
import it and poll it for status updates. Imports block the D1 for their
13501350
duration.
13511351
13521352
Args:
@@ -1387,8 +1387,8 @@ async def import_(
13871387
timeout: float | httpx.Timeout | None | NotGiven = not_given,
13881388
) -> DatabaseImportResponse:
13891389
"""
1390-
Generates a temporary URL for uploading an SQL file to, then instructing the D1
1391-
to import it and polling it for status updates. Imports block the D1 for their
1390+
Generate a temporary URL for uploading an SQL file to, then instruct the D1 to
1391+
import it and poll it for status updates. Imports block the D1 for their
13921392
duration.
13931393
13941394
Args:
@@ -1476,7 +1476,7 @@ def query(
14761476
timeout: float | httpx.Timeout | None | NotGiven = not_given,
14771477
) -> AsyncPaginator[QueryResult, AsyncSinglePage[QueryResult]]:
14781478
"""
1479-
Returns the query result as an object.
1479+
Execute a SQL query against a D1 database and return results as objects.
14801480
14811481
Args:
14821482
account_id: Account identifier tag.
@@ -1511,7 +1511,7 @@ def query(
15111511
timeout: float | httpx.Timeout | None | NotGiven = not_given,
15121512
) -> AsyncPaginator[QueryResult, AsyncSinglePage[QueryResult]]:
15131513
"""
1514-
Returns the query result as an object.
1514+
Execute a SQL query against a D1 database and return results as objects.
15151515
15161516
Args:
15171517
account_id: Account identifier tag.
@@ -1583,10 +1583,10 @@ def raw(
15831583
extra_body: Body | None = None,
15841584
timeout: float | httpx.Timeout | None | NotGiven = not_given,
15851585
) -> AsyncPaginator[DatabaseRawResponse, AsyncSinglePage[DatabaseRawResponse]]:
1586-
"""Returns the query result rows as arrays rather than objects.
1587-
1588-
This is a
1589-
performance-optimized version of the /query endpoint.
1586+
"""
1587+
Execute a SQL query against a D1 database and return result rows as arrays
1588+
rather than objects. This is a performance-optimized version of the /query
1589+
endpoint.
15901590
15911591
Args:
15921592
account_id: Account identifier tag.
@@ -1620,10 +1620,10 @@ def raw(
16201620
extra_body: Body | None = None,
16211621
timeout: float | httpx.Timeout | None | NotGiven = not_given,
16221622
) -> AsyncPaginator[DatabaseRawResponse, AsyncSinglePage[DatabaseRawResponse]]:
1623-
"""Returns the query result rows as arrays rather than objects.
1624-
1625-
This is a
1626-
performance-optimized version of the /query endpoint.
1623+
"""
1624+
Execute a SQL query against a D1 database and return result rows as arrays
1625+
rather than objects. This is a performance-optimized version of the /query
1626+
endpoint.
16271627
16281628
Args:
16291629
account_id: Account identifier tag.

‎src/cloudflare/resources/d1/database/time_travel.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def get_bookmark(
6060
timeout: float | httpx.Timeout | None | NotGiven = not_given,
6161
) -> TimeTravelGetBookmarkResponse:
6262
"""
63-
Retrieves the current bookmark, or the nearest bookmark at or before a provided
63+
Retrieve the current bookmark, or the nearest bookmark at or before a provided
6464
timestamp. Bookmarks can be used with the restore endpoint to revert the
6565
database to a previous point in time.
6666
@@ -118,7 +118,7 @@ def restore(
118118
timeout: float | httpx.Timeout | None | NotGiven = not_given,
119119
) -> TimeTravelRestoreResponse:
120120
"""
121-
Restores a D1 database to a previous point in time either via a bookmark or a
121+
Restore a D1 database to a previous point in time either via a bookmark or a
122122
timestamp.
123123
124124
Args:
@@ -201,7 +201,7 @@ async def get_bookmark(
201201
timeout: float | httpx.Timeout | None | NotGiven = not_given,
202202
) -> TimeTravelGetBookmarkResponse:
203203
"""
204-
Retrieves the current bookmark, or the nearest bookmark at or before a provided
204+
Retrieve the current bookmark, or the nearest bookmark at or before a provided
205205
timestamp. Bookmarks can be used with the restore endpoint to revert the
206206
database to a previous point in time.
207207
@@ -259,7 +259,7 @@ async def restore(
259259
timeout: float | httpx.Timeout | None | NotGiven = not_given,
260260
) -> TimeTravelRestoreResponse:
261261
"""
262-
Restores a D1 database to a previous point in time either via a bookmark or a
262+
Restore a D1 database to a previous point in time either via a bookmark or a
263263
timestamp.
264264
265265
Args:

0 commit comments

Comments
 (0)