File size: 48,684 Bytes
c212805 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 | import PostgrestFilterBuilder from './PostgrestFilterBuilder'
import { GetResult } from './select-query-parser/result'
import {
ClientServerOptions,
Fetch,
GenericSchema,
GenericTable,
GenericView,
} from './types/common/common'
import { RejectExcessProperties } from './types/types'
export default class PostgrestQueryBuilder<
ClientOptions extends ClientServerOptions,
Schema extends GenericSchema,
Relation extends GenericTable | GenericView,
RelationName = unknown,
Relationships = Relation extends { Relationships: infer R } ? R : unknown,
> {
url: URL
headers: Headers
schema?: string
signal?: AbortSignal
fetch?: Fetch
urlLengthLimit: number
/**
* Enable or disable automatic retries for transient errors.
* When enabled, idempotent requests (GET/HEAD/OPTIONS) that fail with network
* errors or HTTP 503/520 responses are automatically retried with exponential
* backoff (1s, 2s, 4s, up to 3 attempts). Defaults to `true` when not specified.
*/
retry?: boolean
/**
* Creates a query builder scoped to a Postgres table or view.
*
* @category Database
*
* @param url - The URL for the query
* @param options - Named parameters
* @param options.headers - Custom headers
* @param options.schema - Postgres schema to use
* @param options.fetch - Custom fetch implementation
* @param options.urlLengthLimit - Maximum URL length before warning
* @param options.retry - Enable automatic retries for transient errors (default: true)
*
* @example Using supabase-js (recommended)
* ```ts
* import { createClient } from '@supabase/supabase-js'
*
* const supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')
* const { data, error } = await supabase.from('users').select('*')
* ```
*
* @example Standalone import for bundle-sensitive environments
* ```ts
* import { PostgrestQueryBuilder } from '@supabase/postgrest-js'
*
* const query = new PostgrestQueryBuilder(
* new URL('https://xyzcompany.supabase.co/rest/v1/users'),
* { headers: { apikey: 'your-publishable-key' }, retry: true }
* )
* ```
*/
constructor(
url: URL,
{
headers = {},
schema,
fetch,
urlLengthLimit = 8000,
retry,
}: {
headers?: HeadersInit
schema?: string
fetch?: Fetch
urlLengthLimit?: number
retry?: boolean
}
) {
this.url = url
this.headers = new Headers(headers)
this.schema = schema
this.fetch = fetch
this.urlLengthLimit = urlLengthLimit
this.retry = retry
}
/**
* Clone URL and headers to prevent shared state between operations.
*/
private cloneRequestState(): { url: URL; headers: Headers } {
return {
url: new URL(this.url.toString()),
headers: new Headers(this.headers),
}
}
/**
* Perform a SELECT query on the table or view.
*
* @param columns - The columns to retrieve, separated by commas. Columns can be renamed when returned with `customName:columnName`
*
* @param options - Named parameters
*
* @param options.head - When set to `true`, `data` will not be returned.
* Useful if you only need the count.
*
* @param options.count - Count algorithm to use to count rows in the table or view.
*
* `"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the
* hood.
*
* `"planned"`: Approximated but fast count algorithm. Uses the Postgres
* statistics under the hood.
*
* `"estimated"`: Uses exact count for low numbers and planned count for high
* numbers.
*
* @remarks
* When using `count` with `.range()` or `.limit()`, the returned `count` is the total number of rows
* that match your filters, not the number of rows in the current page. Use this to build pagination UI.
* - By default, Supabase projects return a maximum of 1,000 rows. This setting can be changed in your project's [API settings](/dashboard/project/_/settings/api). It's recommended that you keep it low to limit the payload size of accidental or malicious requests. You can use `range()` queries to paginate through your data.
* - `select()` can be combined with [Filters](/docs/reference/javascript/using-filters)
* - `select()` can be combined with [Modifiers](/docs/reference/javascript/using-modifiers)
* - `apikey` is a reserved keyword if you're using the [Supabase Platform](/docs/guides/platform) and [should be avoided as a column name](https://github.com/supabase/supabase/issues/5465). *
* @category Database
*
* @example Getting your data
* ```js
* const { data, error } = await supabase
* .from('characters')
* .select()
* ```
*
* @exampleSql Getting your data
* ```sql
* create table
* characters (id int8 primary key, name text);
*
* insert into
* characters (id, name)
* values
* (1, 'Harry'),
* (2, 'Frodo'),
* (3, 'Katniss');
* ```
*
* @exampleResponse Getting your data
* ```json
* {
* "data": [
* {
* "id": 1,
* "name": "Harry"
* },
* {
* "id": 2,
* "name": "Frodo"
* },
* {
* "id": 3,
* "name": "Katniss"
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*
* @exampleDescription Handling errors
* The most useful field on a Postgres error is usually `hint` — when the database knows the fix, it puts the literal SQL there. For example, a permission-denied error (`code: '42501'`) arrives with a `hint` like `"Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;"`. Log the full `error` object so the hint isn't hidden behind `error.message`.
*
* @example Handling errors
* ```js
* const { data, error } = await supabase.from('characters').select()
* if (error) {
* // Logs the full error: message, code, details, and hint.
* console.error(error)
* return
* }
* ```
*
* @exampleResponse Handling errors
* ```json
* {
* "error": {
* "code": "42501",
* "details": null,
* "hint": "Grant the required privileges to the current role with: GRANT SELECT ON public.characters TO anon;",
* "message": "permission denied for table characters"
* },
* "status": 401,
* "statusText": "Unauthorized"
* }
* ```
*
* @example Selecting specific columns
* ```js
* const { data, error } = await supabase
* .from('characters')
* .select('name')
* ```
*
* @exampleSql Selecting specific columns
* ```sql
* create table
* characters (id int8 primary key, name text);
*
* insert into
* characters (id, name)
* values
* (1, 'Frodo'),
* (2, 'Harry'),
* (3, 'Katniss');
* ```
*
* @exampleResponse Selecting specific columns
* ```json
* {
* "data": [
* {
* "name": "Frodo"
* },
* {
* "name": "Harry"
* },
* {
* "name": "Katniss"
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*
* @exampleDescription Query referenced tables
* If your database has foreign key relationships, you can query related tables too.
*
* @example Query referenced tables
* ```js
* const { data, error } = await supabase
* .from('orchestral_sections')
* .select(`
* name,
* instruments (
* name
* )
* `)
* ```
*
* @exampleSql Query referenced tables
* ```sql
* create table
* orchestral_sections (id int8 primary key, name text);
* create table
* instruments (
* id int8 primary key,
* section_id int8 not null references orchestral_sections,
* name text
* );
*
* insert into
* orchestral_sections (id, name)
* values
* (1, 'strings'),
* (2, 'woodwinds');
* insert into
* instruments (id, section_id, name)
* values
* (1, 2, 'flute'),
* (2, 1, 'violin');
* ```
*
* @exampleResponse Query referenced tables
* ```json
* {
* "data": [
* {
* "name": "strings",
* "instruments": [
* {
* "name": "violin"
* }
* ]
* },
* {
* "name": "woodwinds",
* "instruments": [
* {
* "name": "flute"
* }
* ]
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*
* @exampleDescription Query referenced tables with spaces in their names
* If your table name contains spaces, you must use double quotes in the `select` statement to reference the table.
*
* @example Query referenced tables with spaces in their names
* ```js
* const { data, error } = await supabase
* .from('orchestral sections')
* .select(`
* name,
* "musical instruments" (
* name
* )
* `)
* ```
*
* @exampleSql Query referenced tables with spaces in their names
* ```sql
* create table
* "orchestral sections" (id int8 primary key, name text);
* create table
* "musical instruments" (
* id int8 primary key,
* section_id int8 not null references "orchestral sections",
* name text
* );
*
* insert into
* "orchestral sections" (id, name)
* values
* (1, 'strings'),
* (2, 'woodwinds');
* insert into
* "musical instruments" (id, section_id, name)
* values
* (1, 2, 'flute'),
* (2, 1, 'violin');
* ```
*
* @exampleResponse Query referenced tables with spaces in their names
* ```json
* {
* "data": [
* {
* "name": "strings",
* "musical instruments": [
* {
* "name": "violin"
* }
* ]
* },
* {
* "name": "woodwinds",
* "musical instruments": [
* {
* "name": "flute"
* }
* ]
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*
* @exampleDescription Query referenced tables through a join table
* If you're in a situation where your tables are **NOT** directly
* related, but instead are joined by a _join table_, you can still use
* the `select()` method to query the related data. The join table needs
* to have the foreign keys as part of its composite primary key.
*
* @example Query referenced tables through a join table
* ```ts
* const { data, error } = await supabase
* .from('users')
* .select(`
* name,
* teams (
* name
* )
* `)
*
* ```
*
* @exampleSql Query referenced tables through a join table
* ```sql
* create table
* users (
* id int8 primary key,
* name text
* );
* create table
* teams (
* id int8 primary key,
* name text
* );
* -- join table
* create table
* users_teams (
* user_id int8 not null references users,
* team_id int8 not null references teams,
* -- both foreign keys must be part of a composite primary key
* primary key (user_id, team_id)
* );
*
* insert into
* users (id, name)
* values
* (1, 'Kiran'),
* (2, 'Evan');
* insert into
* teams (id, name)
* values
* (1, 'Green'),
* (2, 'Blue');
* insert into
* users_teams (user_id, team_id)
* values
* (1, 1),
* (1, 2),
* (2, 2);
* ```
*
* @exampleResponse Query referenced tables through a join table
* ```json
* {
* "data": [
* {
* "name": "Kiran",
* "teams": [
* {
* "name": "Green"
* },
* {
* "name": "Blue"
* }
* ]
* },
* {
* "name": "Evan",
* "teams": [
* {
* "name": "Blue"
* }
* ]
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
*
* ```
*
* @exampleDescription Query the same referenced table multiple times
* If you need to query the same referenced table twice, use the name of the
* joined column to identify which join to use. You can also give each
* column an alias.
*
* @example Query the same referenced table multiple times
* ```ts
* const { data, error } = await supabase
* .from('messages')
* .select(`
* content,
* from:sender_id(name),
* to:receiver_id(name)
* `)
*
* // To infer types, use the name of the table (in this case `users`) and
* // the name of the foreign key constraint.
* const { data, error } = await supabase
* .from('messages')
* .select(`
* content,
* from:users!messages_sender_id_fkey(name),
* to:users!messages_receiver_id_fkey(name)
* `)
* ```
*
* @exampleSql Query the same referenced table multiple times
* ```sql
* create table
* users (id int8 primary key, name text);
*
* create table
* messages (
* sender_id int8 not null references users,
* receiver_id int8 not null references users,
* content text
* );
*
* insert into
* users (id, name)
* values
* (1, 'Kiran'),
* (2, 'Evan');
*
* insert into
* messages (sender_id, receiver_id, content)
* values
* (1, 2, '👋');
* ```
* ```
*
* @exampleResponse Query the same referenced table multiple times
* ```json
* {
* "data": [
* {
* "content": "👋",
* "from": {
* "name": "Kiran"
* },
* "to": {
* "name": "Evan"
* }
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*
* @exampleDescription Query nested foreign tables through a join table
* You can use the result of a joined table to gather data in
* another foreign table. With multiple references to the same foreign
* table you must specify the column on which to conduct the join.
*
* @example Query nested foreign tables through a join table
* ```ts
* const { data, error } = await supabase
* .from('games')
* .select(`
* game_id:id,
* away_team:teams!games_away_team_fkey (
* users (
* id,
* name
* )
* )
* `)
*
* ```
*
* @exampleSql Query nested foreign tables through a join table
* ```sql
* ```sql
* create table
* users (
* id int8 primary key,
* name text
* );
* create table
* teams (
* id int8 primary key,
* name text
* );
* -- join table
* create table
* users_teams (
* user_id int8 not null references users,
* team_id int8 not null references teams,
*
* primary key (user_id, team_id)
* );
* create table
* games (
* id int8 primary key,
* home_team int8 not null references teams,
* away_team int8 not null references teams,
* name text
* );
*
* insert into users (id, name)
* values
* (1, 'Kiran'),
* (2, 'Evan');
* insert into
* teams (id, name)
* values
* (1, 'Green'),
* (2, 'Blue');
* insert into
* users_teams (user_id, team_id)
* values
* (1, 1),
* (1, 2),
* (2, 2);
* insert into
* games (id, home_team, away_team, name)
* values
* (1, 1, 2, 'Green vs Blue'),
* (2, 2, 1, 'Blue vs Green');
* ```
*
* @exampleResponse Query nested foreign tables through a join table
* ```json
* {
* "data": [
* {
* "game_id": 1,
* "away_team": {
* "users": [
* {
* "id": 1,
* "name": "Kiran"
* },
* {
* "id": 2,
* "name": "Evan"
* }
* ]
* }
* },
* {
* "game_id": 2,
* "away_team": {
* "users": [
* {
* "id": 1,
* "name": "Kiran"
* }
* ]
* }
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
*
* ```
*
* @exampleDescription Filtering through referenced tables
* If the filter on a referenced table's column is not satisfied, the referenced
* table returns `[]` or `null` but the parent table is not filtered out.
* If you want to filter out the parent table rows, use the `!inner` hint
*
* @example Filtering through referenced tables
* ```ts
* const { data, error } = await supabase
* .from('instruments')
* .select('name, orchestral_sections(*)')
* .eq('orchestral_sections.name', 'percussion')
* ```
*
* @exampleSql Filtering through referenced tables
* ```sql
* create table
* orchestral_sections (id int8 primary key, name text);
* create table
* instruments (
* id int8 primary key,
* section_id int8 not null references orchestral_sections,
* name text
* );
*
* insert into
* orchestral_sections (id, name)
* values
* (1, 'strings'),
* (2, 'woodwinds');
* insert into
* instruments (id, section_id, name)
* values
* (1, 2, 'flute'),
* (2, 1, 'violin');
* ```
*
* @exampleResponse Filtering through referenced tables
* ```json
* {
* "data": [
* {
* "name": "flute",
* "orchestral_sections": null
* },
* {
* "name": "violin",
* "orchestral_sections": null
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*
* @exampleDescription Querying referenced table with count
* You can get the number of rows in a related table by using the
* **count** property.
*
* @example Querying referenced table with count
* ```ts
* const { data, error } = await supabase
* .from('orchestral_sections')
* .select(`*, instruments(count)`)
* ```
*
* @exampleSql Querying referenced table with count
* ```sql
* create table orchestral_sections (
* "id" "uuid" primary key default "extensions"."uuid_generate_v4"() not null,
* "name" text
* );
*
* create table characters (
* "id" "uuid" primary key default "extensions"."uuid_generate_v4"() not null,
* "name" text,
* "section_id" "uuid" references public.orchestral_sections on delete cascade
* );
*
* with section as (
* insert into orchestral_sections (name)
* values ('strings') returning id
* )
* insert into instruments (name, section_id) values
* ('violin', (select id from section)),
* ('viola', (select id from section)),
* ('cello', (select id from section)),
* ('double bass', (select id from section));
* ```
*
* @exampleResponse Querying referenced table with count
* ```json
* [
* {
* "id": "693694e7-d993-4360-a6d7-6294e325d9b6",
* "name": "strings",
* "instruments": [
* {
* "count": 4
* }
* ]
* }
* ]
* ```
*
* @exampleDescription Querying with count option
* You can get the number of rows by using the
* [count](/docs/reference/javascript/select#parameters) option.
*
* @example Querying with count option
* ```ts
* const { count, error } = await supabase
* .from('characters')
* .select('*', { count: 'exact', head: true })
* ```
*
* @exampleSql Querying with count option
* ```sql
* create table
* characters (id int8 primary key, name text);
*
* insert into
* characters (id, name)
* values
* (1, 'Luke'),
* (2, 'Leia'),
* (3, 'Han');
* ```
*
* @exampleResponse Querying with count option
* ```json
* {
* "count": 3,
* "status": 200,
* "statusText": "OK"
* }
* ```
*
* @exampleDescription Querying JSON data
* You can select and filter data inside of
* [JSON](/docs/guides/database/json) columns. Postgres offers some
* [operators](/docs/guides/database/json#query-the-jsonb-data) for
* querying JSON data.
*
* @example Querying JSON data
* ```ts
* const { data, error } = await supabase
* .from('users')
* .select(`
* id, name,
* address->city
* `)
* ```
*
* @exampleSql Querying JSON data
* ```sql
* create table
* users (
* id int8 primary key,
* name text,
* address jsonb
* );
*
* insert into
* users (id, name, address)
* values
* (1, 'Frodo', '{"city":"Hobbiton"}');
* ```
*
* @exampleResponse Querying JSON data
* ```json
* {
* "data": [
* {
* "id": 1,
* "name": "Frodo",
* "city": "Hobbiton"
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*
* @exampleDescription Querying referenced table with inner join
* If you don't want to return the referenced table contents, you can leave the parenthesis empty.
* Like `.select('name, orchestral_sections!inner()')`.
*
* @example Querying referenced table with inner join
* ```ts
* const { data, error } = await supabase
* .from('instruments')
* .select('name, orchestral_sections!inner(name)')
* .eq('orchestral_sections.name', 'woodwinds')
* .limit(1)
* ```
*
* @exampleSql Querying referenced table with inner join
* ```sql
* create table orchestral_sections (
* "id" "uuid" primary key default "extensions"."uuid_generate_v4"() not null,
* "name" text
* );
*
* create table instruments (
* "id" "uuid" primary key default "extensions"."uuid_generate_v4"() not null,
* "name" text,
* "section_id" "uuid" references public.orchestral_sections on delete cascade
* );
*
* with section as (
* insert into orchestral_sections (name)
* values ('woodwinds') returning id
* )
* insert into instruments (name, section_id) values
* ('flute', (select id from section)),
* ('clarinet', (select id from section)),
* ('bassoon', (select id from section)),
* ('piccolo', (select id from section));
* ```
*
* @exampleResponse Querying referenced table with inner join
* ```json
* {
* "data": [
* {
* "name": "flute",
* "orchestral_sections": {"name": "woodwinds"}
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*
* @exampleDescription Switching schemas per query
* In addition to setting the schema during initialization, you can also switch schemas on a per-query basis.
* Make sure you've set up your [database privileges and API settings](/docs/guides/api/using-custom-schemas).
*
* @example Switching schemas per query
* ```ts
* const { data, error } = await supabase
* .schema('myschema')
* .from('mytable')
* .select()
* ```
*
* @exampleSql Switching schemas per query
* ```sql
* create schema myschema;
*
* create table myschema.mytable (
* id uuid primary key default gen_random_uuid(),
* data text
* );
*
* insert into myschema.mytable (data) values ('mydata');
* ```
*
* @exampleResponse Switching schemas per query
* ```json
* {
* "data": [
* {
* "id": "4162e008-27b0-4c0f-82dc-ccaeee9a624d",
* "data": "mydata"
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*/
select<
Query extends string = '*',
ResultOne = GetResult<
Schema,
Relation['Row'],
RelationName,
Relationships,
Query,
ClientOptions
>,
>(
columns?: Query,
options?: {
head?: boolean
count?: 'exact' | 'planned' | 'estimated' | (string & {})
}
): PostgrestFilterBuilder<
ClientOptions,
Schema,
Relation['Row'],
ResultOne[],
RelationName,
Relationships,
'GET'
> {
const { head = false, count } = options ?? {}
const method = head ? 'HEAD' : 'GET'
// Remove whitespaces except when quoted
let quoted = false
const cleanedColumns = (columns ?? '*')
.split('')
.map((c) => {
if (/\s/.test(c) && !quoted) {
return ''
}
if (c === '"') {
quoted = !quoted
}
return c
})
.join('')
const { url, headers } = this.cloneRequestState()
url.searchParams.set('select', cleanedColumns)
if (count) {
headers.append('Prefer', `count=${count}`)
}
return new PostgrestFilterBuilder({
method,
url,
headers,
schema: this.schema,
fetch: this.fetch,
urlLengthLimit: this.urlLengthLimit,
retry: this.retry,
})
}
/**
* Perform an INSERT into the table or view.
*
* By default, inserted rows are not returned. To return it, chain the call
* with `.select()`.
*
* @param values - The values to insert. Pass an object to insert a single row
* or an array to insert multiple rows.
*
* @param options - Named parameters
*
* @param options.count - Count algorithm to use to count inserted rows.
*
* `"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the
* hood.
*
* `"planned"`: Approximated but fast count algorithm. Uses the Postgres
* statistics under the hood.
*
* `"estimated"`: Uses exact count for low numbers and planned count for high
* numbers.
*
* @param options.defaultToNull - Make missing fields default to `null`.
* Otherwise, use the default value for the column. Only applies for bulk
* inserts.
*
* @category Database
*
* @example Create a record
* ```ts
* const { error } = await supabase
* .from('countries')
* .insert({ id: 1, name: 'Mordor' })
* ```
*
* @exampleSql Create a record
* ```sql
* create table
* countries (id int8 primary key, name text);
* ```
*
* @exampleResponse Create a record
* ```json
* {
* "status": 201,
* "statusText": "Created"
* }
* ```
*
* @exampleDescription Handling errors
* `error.hint` from Postgres often contains the actionable fix (e.g. `"Grant the required privileges to the current role with: GRANT INSERT ON public.countries TO anon;"` for a `42501` permission-denied error). Log the full `error` object so it isn't hidden behind `error.message`.
*
* @example Handling errors
* ```js
* const { error } = await supabase.from('countries').insert({ id: 1, name: 'Mordor' })
* if (error) console.error(error)
* ```
*
* @example Create a record and return it
* ```ts
* const { data, error } = await supabase
* .from('countries')
* .insert({ id: 1, name: 'Mordor' })
* .select()
* ```
*
* @exampleSql Create a record and return it
* ```sql
* create table
* countries (id int8 primary key, name text);
* ```
*
* @exampleResponse Create a record and return it
* ```json
* {
* "data": [
* {
* "id": 1,
* "name": "Mordor"
* }
* ],
* "status": 201,
* "statusText": "Created"
* }
* ```
*
* @exampleDescription Bulk create
* A bulk create operation is handled in a single transaction.
* If any of the inserts fail, none of the rows are inserted.
*
* @example Bulk create
* ```ts
* const { error } = await supabase
* .from('countries')
* .insert([
* { id: 1, name: 'Mordor' },
* { id: 1, name: 'The Shire' },
* ])
* ```
*
* @exampleSql Bulk create
* ```sql
* create table
* countries (id int8 primary key, name text);
* ```
*
* @exampleResponse Bulk create
* ```json
* {
* "error": {
* "code": "23505",
* "details": "Key (id)=(1) already exists.",
* "hint": null,
* "message": "duplicate key value violates unique constraint \"countries_pkey\""
* },
* "status": 409,
* "statusText": "Conflict"
* }
* ```
*/
insert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
values:
| RejectExcessProperties<
Relation extends { Insert: unknown } ? Relation['Insert'] : never,
Row
>
| RejectExcessProperties<
Relation extends { Insert: unknown } ? Relation['Insert'] : never,
Row
>[],
{
count,
defaultToNull = true,
}: {
count?: 'exact' | 'planned' | 'estimated' | (string & {})
defaultToNull?: boolean
} = {}
): PostgrestFilterBuilder<
ClientOptions,
Schema,
Relation['Row'],
null,
RelationName,
Relationships,
'POST'
> {
const method = 'POST'
const { url, headers } = this.cloneRequestState()
if (count) {
headers.append('Prefer', `count=${count}`)
}
if (!defaultToNull) {
headers.append('Prefer', `missing=default`)
}
if (Array.isArray(values)) {
const columns = values.reduce((acc, x) => acc.concat(Object.keys(x)), [] as string[])
if (columns.length > 0) {
const uniqueColumns = [...new Set(columns)].map((column) => `"${column}"`)
url.searchParams.set('columns', uniqueColumns.join(','))
}
}
return new PostgrestFilterBuilder({
method,
url,
headers,
schema: this.schema,
body: values,
fetch: this.fetch ?? fetch,
urlLengthLimit: this.urlLengthLimit,
retry: this.retry,
})
}
/**
* Perform an UPSERT on the table or view. Depending on the column(s) passed
* to `onConflict`, `.upsert()` allows you to perform the equivalent of
* `.insert()` if a row with the corresponding `onConflict` columns doesn't
* exist, or if it does exist, perform an alternative action depending on
* `ignoreDuplicates`.
*
* By default, upserted rows are not returned. To return it, chain the call
* with `.select()`.
*
* @param values - The values to upsert with. Pass an object to upsert a
* single row or an array to upsert multiple rows.
*
* @param options - Named parameters
*
* @param options.onConflict - Comma-separated UNIQUE column(s) to specify how
* duplicate rows are determined. Two rows are duplicates if all the
* `onConflict` columns are equal.
*
* @param options.ignoreDuplicates - If `true`, duplicate rows are ignored. If
* `false`, duplicate rows are merged with existing rows.
*
* @param options.count - Count algorithm to use to count upserted rows.
*
* `"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the
* hood.
*
* `"planned"`: Approximated but fast count algorithm. Uses the Postgres
* statistics under the hood.
*
* `"estimated"`: Uses exact count for low numbers and planned count for high
* numbers.
*
* @param options.defaultToNull - Make missing fields default to `null`.
* Otherwise, use the default value for the column. This only applies when
* inserting new rows, not when merging with existing rows under
* `ignoreDuplicates: false`. This also only applies when doing bulk upserts.
*
* @example Upsert a single row using a unique key
* ```ts
* // Upserting a single row, overwriting based on the 'username' unique column
* const { data, error } = await supabase
* .from('users')
* .upsert({ username: 'supabot' }, { onConflict: 'username' })
*
* // Example response:
* // {
* // data: [
* // { id: 4, message: 'bar', username: 'supabot' }
* // ],
* // error: null
* // }
* ```
*
* @example Upsert with conflict resolution and exact row counting
* ```ts
* // Upserting and returning exact count
* const { data, error, count } = await supabase
* .from('users')
* .upsert(
* {
* id: 3,
* message: 'foo',
* username: 'supabot'
* },
* {
* onConflict: 'username',
* count: 'exact'
* }
* )
*
* // Example response:
* // {
* // data: [
* // {
* // id: 42,
* // handle: "saoirse",
* // display_name: "Saoirse"
* // }
* // ],
* // count: 1,
* // error: null
* // }
* ```
*
* @category Database
*
* @remarks
* - Primary keys must be included in `values` to use upsert.
*
* @example Upsert your data
* ```ts
* const { data, error } = await supabase
* .from('instruments')
* .upsert({ id: 1, name: 'piano' })
* .select()
* ```
*
* @exampleSql Upsert your data
* ```sql
* create table
* instruments (id int8 primary key, name text);
*
* insert into
* instruments (id, name)
* values
* (1, 'harpsichord');
* ```
*
* @exampleResponse Upsert your data
* ```json
* {
* "data": [
* {
* "id": 1,
* "name": "piano"
* }
* ],
* "status": 201,
* "statusText": "Created"
* }
* ```
*
* @exampleDescription Handling errors
* `error.hint` from Postgres often contains the actionable fix (e.g. `"Grant the required privileges to the current role with: GRANT INSERT, UPDATE ON public.instruments TO anon;"` for a `42501` permission-denied error). Log the full `error` object so it isn't hidden behind `error.message`.
*
* @example Handling errors
* ```js
* const { data, error } = await supabase.from('instruments').upsert({ id: 1, name: 'piano' }).select()
* if (error) console.error(error)
* ```
*
* @example Bulk Upsert your data
* ```ts
* const { data, error } = await supabase
* .from('instruments')
* .upsert([
* { id: 1, name: 'piano' },
* { id: 2, name: 'harp' },
* ])
* .select()
* ```
*
* @exampleSql Bulk Upsert your data
* ```sql
* create table
* instruments (id int8 primary key, name text);
*
* insert into
* instruments (id, name)
* values
* (1, 'harpsichord');
* ```
*
* @exampleResponse Bulk Upsert your data
* ```json
* {
* "data": [
* {
* "id": 1,
* "name": "piano"
* },
* {
* "id": 2,
* "name": "harp"
* }
* ],
* "status": 201,
* "statusText": "Created"
* }
* ```
*
* @exampleDescription Upserting into tables with constraints
* In the following query, `upsert()` implicitly uses the `id`
* (primary key) column to determine conflicts. If there is no existing
* row with the same `id`, `upsert()` inserts a new row, which
* will fail in this case as there is already a row with `handle` `"saoirse"`.
* Using the `onConflict` option, you can instruct `upsert()` to use
* another column with a unique constraint to determine conflicts.
*
* @example Upserting into tables with constraints
* ```ts
* const { data, error } = await supabase
* .from('users')
* .upsert({ id: 42, handle: 'saoirse', display_name: 'Saoirse' })
* .select()
* ```
*
* @exampleSql Upserting into tables with constraints
* ```sql
* create table
* users (
* id int8 generated by default as identity primary key,
* handle text not null unique,
* display_name text
* );
*
* insert into
* users (id, handle, display_name)
* values
* (1, 'saoirse', null);
* ```
*
* @exampleResponse Upserting into tables with constraints
* ```json
* {
* "error": {
* "code": "23505",
* "details": "Key (handle)=(saoirse) already exists.",
* "hint": null,
* "message": "duplicate key value violates unique constraint \"users_handle_key\""
* },
* "status": 409,
* "statusText": "Conflict"
* }
* ```
*/
upsert<Row extends Relation extends { Insert: unknown } ? Relation['Insert'] : never>(
values:
| RejectExcessProperties<
Relation extends { Insert: unknown } ? Relation['Insert'] : never,
Row
>
| RejectExcessProperties<
Relation extends { Insert: unknown } ? Relation['Insert'] : never,
Row
>[],
{
onConflict,
ignoreDuplicates = false,
count,
defaultToNull = true,
}: {
onConflict?: string
ignoreDuplicates?: boolean
count?: 'exact' | 'planned' | 'estimated' | (string & {})
defaultToNull?: boolean
} = {}
): PostgrestFilterBuilder<
ClientOptions,
Schema,
Relation['Row'],
null,
RelationName,
Relationships,
'POST'
> {
const method = 'POST'
const { url, headers } = this.cloneRequestState()
headers.append('Prefer', `resolution=${ignoreDuplicates ? 'ignore' : 'merge'}-duplicates`)
if (onConflict !== undefined) url.searchParams.set('on_conflict', onConflict)
if (count) {
headers.append('Prefer', `count=${count}`)
}
if (!defaultToNull) {
headers.append('Prefer', 'missing=default')
}
if (Array.isArray(values)) {
const columns = values.reduce((acc, x) => acc.concat(Object.keys(x)), [] as string[])
if (columns.length > 0) {
const uniqueColumns = [...new Set(columns)].map((column) => `"${column}"`)
url.searchParams.set('columns', uniqueColumns.join(','))
}
}
return new PostgrestFilterBuilder({
method,
url,
headers,
schema: this.schema,
body: values,
fetch: this.fetch ?? fetch,
urlLengthLimit: this.urlLengthLimit,
retry: this.retry,
})
}
/**
* Perform an UPDATE on the table or view.
*
* By default, updated rows are not returned. To return it, chain the call
* with `.select()` after filters.
*
* @param values - The values to update with
*
* @param options - Named parameters
*
* @param options.count - Count algorithm to use to count updated rows.
*
* `"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the
* hood.
*
* `"planned"`: Approximated but fast count algorithm. Uses the Postgres
* statistics under the hood.
*
* `"estimated"`: Uses exact count for low numbers and planned count for high
* numbers.
*
* @category Database
*
* @remarks
* - `update()` should always be combined with [Filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to update.
*
* @example Updating your data
* ```ts
* const { error } = await supabase
* .from('instruments')
* .update({ name: 'piano' })
* .eq('id', 1)
* ```
*
* @exampleSql Updating your data
* ```sql
* create table
* instruments (id int8 primary key, name text);
*
* insert into
* instruments (id, name)
* values
* (1, 'harpsichord');
* ```
*
* @exampleResponse Updating your data
* ```json
* {
* "status": 204,
* "statusText": "No Content"
* }
* ```
*
* @exampleDescription Handling errors
* `error.hint` from Postgres often contains the actionable fix (e.g. `"Grant the required privileges to the current role with: GRANT UPDATE ON public.instruments TO anon;"` for a `42501` permission-denied error). Log the full `error` object so it isn't hidden behind `error.message`.
*
* @example Handling errors
* ```js
* const { error } = await supabase.from('instruments').update({ name: 'piano' }).eq('id', 1)
* if (error) console.error(error)
* ```
*
* @example Update a record and return it
* ```ts
* const { data, error } = await supabase
* .from('instruments')
* .update({ name: 'piano' })
* .eq('id', 1)
* .select()
* ```
*
* @exampleSql Update a record and return it
* ```sql
* create table
* instruments (id int8 primary key, name text);
*
* insert into
* instruments (id, name)
* values
* (1, 'harpsichord');
* ```
*
* @exampleResponse Update a record and return it
* ```json
* {
* "data": [
* {
* "id": 1,
* "name": "piano"
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*
* @exampleDescription Updating JSON data
* Postgres offers some
* [operators](/docs/guides/database/json#query-the-jsonb-data) for
* working with JSON data. Currently, it is only possible to update the entire JSON document.
*
* @example Updating JSON data
* ```ts
* const { data, error } = await supabase
* .from('users')
* .update({
* address: {
* street: 'Melrose Place',
* postcode: 90210
* }
* })
* .eq('address->postcode', 90210)
* .select()
* ```
*
* @exampleSql Updating JSON data
* ```sql
* create table
* users (
* id int8 primary key,
* name text,
* address jsonb
* );
*
* insert into
* users (id, name, address)
* values
* (1, 'Michael', '{ "postcode": 90210 }');
* ```
*
* @exampleResponse Updating JSON data
* ```json
* {
* "data": [
* {
* "id": 1,
* "name": "Michael",
* "address": {
* "street": "Melrose Place",
* "postcode": 90210
* }
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*/
update<Row extends Relation extends { Update: unknown } ? Relation['Update'] : never>(
values: RejectExcessProperties<
Relation extends { Update: unknown } ? Relation['Update'] : never,
Row
>,
{
count,
}: {
count?: 'exact' | 'planned' | 'estimated' | (string & {})
} = {}
): PostgrestFilterBuilder<
ClientOptions,
Schema,
Relation['Row'],
null,
RelationName,
Relationships,
'PATCH'
> {
const method = 'PATCH'
const { url, headers } = this.cloneRequestState()
if (count) {
headers.append('Prefer', `count=${count}`)
}
return new PostgrestFilterBuilder({
method,
url,
headers,
schema: this.schema,
body: values,
fetch: this.fetch ?? fetch,
urlLengthLimit: this.urlLengthLimit,
retry: this.retry,
})
}
/**
* Perform a DELETE on the table or view.
*
* By default, deleted rows are not returned. To return it, chain the call
* with `.select()` after filters.
*
* @param options - Named parameters
*
* @param options.count - Count algorithm to use to count deleted rows.
*
* `"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the
* hood.
*
* `"planned"`: Approximated but fast count algorithm. Uses the Postgres
* statistics under the hood.
*
* `"estimated"`: Uses exact count for low numbers and planned count for high
* numbers.
*
* @category Database
*
* @remarks
* - `delete()` should always be combined with [filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to delete.
* - If you use `delete()` with filters and you have
* [RLS](/docs/learn/auth-deep-dive/auth-row-level-security) enabled, only
* rows visible through `SELECT` policies are deleted. Note that by default
* no rows are visible, so you need at least one `SELECT`/`ALL` policy that
* makes the rows visible.
* - When using `delete().in()`, specify an array of values to target multiple rows with a single query. This is particularly useful for batch deleting entries that share common criteria, such as deleting users by their IDs. Ensure that the array you provide accurately represents all records you intend to delete to avoid unintended data removal.
*
* @example Delete a single record
* ```ts
* const response = await supabase
* .from('countries')
* .delete()
* .eq('id', 1)
* ```
*
* @exampleSql Delete a single record
* ```sql
* create table
* countries (id int8 primary key, name text);
*
* insert into
* countries (id, name)
* values
* (1, 'Mordor');
* ```
*
* @exampleResponse Delete a single record
* ```json
* {
* "status": 204,
* "statusText": "No Content"
* }
* ```
*
* @exampleDescription Handling errors
* `error.hint` from Postgres often contains the actionable fix (e.g. `"Grant the required privileges to the current role with: GRANT DELETE ON public.countries TO anon;"` for a `42501` permission-denied error). Log the full `error` object so it isn't hidden behind `error.message`.
*
* @example Handling errors
* ```js
* const { error } = await supabase.from('countries').delete().eq('id', 1)
* if (error) console.error(error)
* ```
*
* @example Delete a record and return it
* ```ts
* const { data, error } = await supabase
* .from('countries')
* .delete()
* .eq('id', 1)
* .select()
* ```
*
* @exampleSql Delete a record and return it
* ```sql
* create table
* countries (id int8 primary key, name text);
*
* insert into
* countries (id, name)
* values
* (1, 'Mordor');
* ```
*
* @exampleResponse Delete a record and return it
* ```json
* {
* "data": [
* {
* "id": 1,
* "name": "Mordor"
* }
* ],
* "status": 200,
* "statusText": "OK"
* }
* ```
*
* @example Delete multiple records
* ```ts
* const response = await supabase
* .from('countries')
* .delete()
* .in('id', [1, 2, 3])
* ```
*
* @exampleSql Delete multiple records
* ```sql
* create table
* countries (id int8 primary key, name text);
*
* insert into
* countries (id, name)
* values
* (1, 'Rohan'), (2, 'The Shire'), (3, 'Mordor');
* ```
*
* @exampleResponse Delete multiple records
* ```json
* {
* "status": 204,
* "statusText": "No Content"
* }
* ```
*/
delete({
count,
}: {
count?: 'exact' | 'planned' | 'estimated' | (string & {})
} = {}): PostgrestFilterBuilder<
ClientOptions,
Schema,
Relation['Row'],
null,
RelationName,
Relationships,
'DELETE'
> {
const method = 'DELETE'
const { url, headers } = this.cloneRequestState()
if (count) {
headers.append('Prefer', `count=${count}`)
}
return new PostgrestFilterBuilder({
method,
url,
headers,
schema: this.schema,
fetch: this.fetch ?? fetch,
urlLengthLimit: this.urlLengthLimit,
retry: this.retry,
})
}
}
|