{ "id": 0, "name": "@supabase/postgrest-js", "variant": "project", "kind": 1, "flags": {}, "children": [ { "id": 745, "name": "PostgrestBuilder", "variant": "declaration", "kind": 128, "flags": { "isAbstract": true }, "children": [ { "id": 746, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 57, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L57" } ], "signatures": [ { "id": 747, "name": "PostgrestBuilder", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a builder configured for a specific PostgREST request." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'public-anon-key' }) }\n)\n```" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "Creating a Postgrest query builder", "content": [ { "kind": "code", "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'public-anon-key' }) }\n)\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 57, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L57" } ], "typeParameters": [ { "id": 748, "name": "ClientOptions", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" } }, { "id": 749, "name": "Result", "variant": "typeParam", "kind": 131072, "flags": {} }, { "id": 750, "name": "ThrowOnError", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "boolean" }, "default": { "type": "literal", "value": false } } ], "parameters": [ { "id": 751, "name": "builder", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 752, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 757, "name": "body", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 62, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L62" } ], "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 760, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 65, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L65" } ], "type": { "type": "reflection", "declaration": { "id": 761, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 762, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 763, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" } ] } }, { "id": 764, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 765, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 766, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" } ] } }, { "id": 767, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 755, "name": "headers", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 60, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L60" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "HeadersInit" }, "name": "HeadersInit", "package": "typescript" } }, { "id": 768, "name": "isMaybeSingle", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 66, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L66" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 753, "name": "method", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 58, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L58" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] } }, { "id": 756, "name": "schema", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 61, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L61" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 758, "name": "shouldThrowOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 63, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L63" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 759, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 64, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L64" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" } }, { "id": 754, "name": "url", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 59, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L59" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } }, { "id": 769, "name": "urlLengthLimit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 67, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L67" } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [757, 760, 755, 768, 753, 756, 758, 759, 754, 769] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 57, "character": 23, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L57" } ] } } } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 748, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 750, "name": "ThrowOnError", "package": "@supabase/postgrest-js", "qualifiedName": "default.ThrowOnError", "refersToTypeParameter": true } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 774, "name": "body", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 25, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L25" } ], "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 777, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 28, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L28" } ], "type": { "type": "reflection", "declaration": { "id": 778, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 779, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 780, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" } ] } }, { "id": 781, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 782, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 783, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" } ] } }, { "id": 784, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 772, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 23, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L23" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" } }, { "id": 785, "name": "isMaybeSingle", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 29, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L29" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 770, "name": "method", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 21, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] } }, { "id": 773, "name": "schema", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 24, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L24" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 775, "name": "shouldThrowOnError", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 26, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L26" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 776, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 27, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L27" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" } }, { "id": 771, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 22, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L22" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } }, { "id": 786, "name": "urlLengthLimit", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 30, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L30" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 808, "name": "overrideTypes", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 424, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L424" } ], "signatures": [ { "id": 809, "name": "overrideTypes", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Override the type of the returned " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " field in the response." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A PostgrestBuilder instance with the new type" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "Complete Override type of successful response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Complete Override type of successful response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // MyType[]\n```" } ] }, { "tag": "@example", "name": "Complete Override type of object response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Complete Override type of object response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // MyType | null\n```" } ] }, { "tag": "@example", "name": "Partial Override type of successful response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Partial Override type of successful response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // Array\n```" } ] }, { "tag": "@example", "name": "Partial Override type of object response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Partial Override type of object response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" } ] }, { "tag": "@example", "name": "Example 5", "content": [ { "kind": "code", "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 424, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L424" } ], "typeParameters": [ { "id": 810, "name": "NewResult", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The new type to cast the response data to" } ] } }, { "id": 811, "name": "Options", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Optional type configuration (defaults to { merge: true })" } ] }, "type": { "type": "reflection", "declaration": { "id": 812, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 813, "name": "merge", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 22, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [813] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 20, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ] } }, "default": { "type": "reflection", "declaration": { "id": 814, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 815, "name": "merge", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 44, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ], "type": { "type": "literal", "value": true } } ], "groups": [ { "title": "Properties", "children": [815] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 42, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ] } } } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 748, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "IsValidResultOverride" }, "typeArguments": [ { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "literal", "value": false }, { "type": "literal", "value": false } ], "name": "IsValidResultOverride", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/types.ts", "qualifiedName": "ContainsNull" }, "typeArguments": [ { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "ContainsNull", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "MergePartialResult" }, "typeArguments": [ { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "NonNullable" }, "typeArguments": [ { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "NonNullable", "package": "typescript" }, { "type": "reference", "target": 572, "name": "Options", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "MergePartialResult", "package": "@supabase/postgrest-js" } ] }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "MergePartialResult" }, "typeArguments": [ { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 572, "name": "Options", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "MergePartialResult", "package": "@supabase/postgrest-js" } }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "CheckMatchingArrayTypes" }, "typeArguments": [ { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "CheckMatchingArrayTypes", "package": "@supabase/postgrest-js" } }, { "type": "reference", "target": 750, "name": "ThrowOnError", "package": "@supabase/postgrest-js", "qualifiedName": "default.ThrowOnError", "refersToTypeParameter": true } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 805, "name": "returns", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 318, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L318" } ], "signatures": [ { "id": 806, "name": "returns", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Override the type of the returned " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Use overrideTypes() method at the end of your call chain instead" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 318, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L318" } ], "typeParameters": [ { "id": 807, "name": "NewResult", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The new result type to override with" } ] } } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 748, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "CheckMatchingArrayTypes" }, "typeArguments": [ { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 807, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "CheckMatchingArrayTypes", "package": "@supabase/postgrest-js" }, { "type": "reference", "target": 750, "name": "ThrowOnError", "package": "@supabase/postgrest-js", "qualifiedName": "default.ThrowOnError", "refersToTypeParameter": true } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 789, "name": "setHeader", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 104, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L104" } ], "signatures": [ { "id": 790, "name": "setHeader", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Set an HTTP header for the request." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 104, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L104" } ], "parameters": [ { "id": 791, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 792, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 793, "name": "then", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 113, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" } ], "signatures": [ { "id": 794, "name": "then", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 113, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" } ], "typeParameters": [ { "id": 795, "name": "TResult1", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "target": 750, "name": "ThrowOnError", "package": "@supabase/postgrest-js", "qualifiedName": "default.ThrowOnError", "refersToTypeParameter": true }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "reference", "target": 839, "typeArguments": [ { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "PostgrestResponseSuccess", "package": "@supabase/postgrest-js" }, "falseType": { "type": "reference", "target": 846, "typeArguments": [ { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "PostgrestSingleResponse", "package": "@supabase/postgrest-js" } } }, { "id": 796, "name": "TResult2", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 797, "name": "onfulfilled", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 798, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 120, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" } ], "signatures": [ { "id": 799, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 120, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" } ], "parameters": [ { "id": 800, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "conditional", "checkType": { "type": "reference", "target": 750, "name": "ThrowOnError", "package": "@supabase/postgrest-js", "qualifiedName": "default.ThrowOnError", "refersToTypeParameter": true }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "reference", "target": 839, "typeArguments": [ { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "PostgrestResponseSuccess", "package": "@supabase/postgrest-js" }, "falseType": { "type": "reference", "target": 846, "typeArguments": [ { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "PostgrestSingleResponse", "package": "@supabase/postgrest-js" } } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 559, "name": "TResult1", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 559, "name": "TResult1", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "PromiseLike", "package": "typescript" } ] } } ] } } ] } }, { "id": 801, "name": "onrejected", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 802, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 127, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L127" } ], "signatures": [ { "id": 803, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 127, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L127" } ], "parameters": [ { "id": 804, "name": "reason", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 560, "name": "TResult2", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 560, "name": "TResult2", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "PromiseLike", "package": "typescript" } ] } } ] } } ] } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": 559, "name": "TResult1", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 560, "name": "TResult2", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ] } ], "name": "PromiseLike", "package": "typescript" }, "implementationOf": { "type": "reference", "target": -1, "name": "PromiseLike.then" } } ], "implementationOf": { "type": "reference", "target": -1, "name": "PromiseLike.then" } }, { "id": 787, "name": "throwOnError", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 94, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L94" } ], "signatures": [ { "id": 788, "name": "throwOnError", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" }, { "kind": "inline-tag", "tag": "@link", "text": "https://github.com/supabase/supabase-js/issues/92", "target": "https://github.com/supabase/supabase-js/issues/92" } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 94, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L94" } ], "type": { "type": "intersection", "types": [ { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 748, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 750, "name": "ThrowOnError", "package": "@supabase/postgrest-js", "qualifiedName": "default.ThrowOnError", "refersToTypeParameter": true } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 748, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "literal", "value": true } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } ] } } ] } ], "groups": [ { "title": "Constructors", "children": [746] }, { "title": "Properties", "children": [774, 777, 772, 785, 770, 773, 775, 776, 771, 786] }, { "title": "Methods", "children": [808, 805, 789, 793, 787] } ], "categories": [ { "title": "Database", "children": [746, 808, 805, 789, 793, 787] }, { "title": "Other", "children": [774, 777, 772, 785, 770, 773, 775, 776, 771, 786] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 12, "character": 30, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L12" } ], "typeParameters": [ { "id": 816, "name": "ClientOptions", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" } }, { "id": 817, "name": "Result", "variant": "typeParam", "kind": 131072, "flags": {} }, { "id": 818, "name": "ThrowOnError", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "boolean" }, "default": { "type": "literal", "value": false } } ], "extendedBy": [ { "type": "reference", "target": 584, "name": "PostgrestTransformBuilder" } ], "implementedTypes": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "conditional", "checkType": { "type": "reference", "target": 750, "name": "ThrowOnError", "package": "@supabase/postgrest-js", "qualifiedName": "default.ThrowOnError", "refersToTypeParameter": true }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "reference", "target": 839, "typeArguments": [ { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "PostgrestResponseSuccess", "package": "@supabase/postgrest-js" }, "falseType": { "type": "reference", "target": 846, "typeArguments": [ { "type": "reference", "target": 749, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "PostgrestSingleResponse", "package": "@supabase/postgrest-js" } } ], "name": "PromiseLike", "package": "typescript" } ] }, { "id": 9, "name": "PostgrestClient", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "PostgREST client." } ] }, "children": [ { "id": 10, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 92, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L92" } ], "signatures": [ { "id": 11, "name": "PostgrestClient", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a PostgREST client." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {\n headers: { apikey: 'public-anon-key' },\n schema: 'public',\n timeout: 30000, // 30 second timeout\n})\n```" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- A " }, { "kind": "code", "text": "`timeout`" }, { "kind": "text", "text": " option (in milliseconds) can be set to automatically abort requests that take too long.\n- A " }, { "kind": "code", "text": "`urlLengthLimit`" }, { "kind": "text", "text": " option (default: 8000) can be set to control when URL length warnings are included in error messages for aborted requests." } ] }, { "tag": "@example", "name": "Creating a Postgrest client", "content": [ { "kind": "code", "text": "```ts\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {\n headers: { apikey: 'public-anon-key' },\n schema: 'public',\n})\n```" } ] }, { "tag": "@example", "name": "With timeout", "content": [ { "kind": "code", "text": "```ts\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst postgrest = new PostgrestClient('https://xyzcompany.supabase.co/rest/v1', {\n headers: { apikey: 'public-anon-key' },\n schema: 'public',\n timeout: 30000, // 30 second timeout\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 92, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L92" } ], "typeParameters": [ { "id": 12, "name": "Database", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "any" } }, { "id": 13, "name": "ClientOptions", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" }, "default": { "type": "conditional", "checkType": { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true }, "extendsType": { "type": "reflection", "declaration": { "id": 14, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 15, "name": "__InternalSupabase", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 19, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L19" } ], "type": { "type": "reference", "target": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "I" }, "name": "I", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } ], "groups": [ { "title": "Properties", "children": [15] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 18, "character": 63, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L18" } ] } }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "I" }, "name": "I", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "reflection", "declaration": { "id": 16, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } } } }, { "id": 17, "name": "SchemaName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "conditional", "checkType": { "type": "literal", "value": "public" }, "extendsType": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Exclude" }, "typeArguments": [ { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true } }, { "type": "literal", "value": "__InternalSupabase" } ], "name": "Exclude", "package": "typescript" }, "trueType": { "type": "literal", "value": "public" }, "falseType": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Exclude" }, "typeArguments": [ { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true } }, { "type": "literal", "value": "__InternalSupabase" } ], "name": "Exclude", "package": "typescript" } ] } } }, { "id": 18, "name": "Schema", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" }, "default": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 17, "name": "SchemaName", "package": "@supabase/postgrest-js", "qualifiedName": "default.SchemaName", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true }, { "type": "literal", "value": "__InternalSupabase" } ], "name": "Omit", "package": "typescript" } }, "extendsType": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "any" } } } ], "parameters": [ { "id": 19, "name": "url", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "URL of the PostgREST endpoint" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 20, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 21, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 24, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Custom fetch" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 103, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L103" } ], "type": { "type": "reflection", "declaration": { "id": 25, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 26, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 27, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" } ] } }, { "id": 28, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 29, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 30, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" } ] } }, { "id": 31, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 22, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Custom headers" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 101, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L101" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "HeadersInit" }, "name": "HeadersInit", "package": "typescript" }, "defaultValue": "{}" }, { "id": 23, "name": "schema", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Postgres schema to switch to" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 102, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L102" } ], "type": { "type": "reference", "target": 17, "name": "SchemaName", "package": "@supabase/postgrest-js", "qualifiedName": "default.SchemaName", "refersToTypeParameter": true } }, { "id": 32, "name": "timeout", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Optional timeout in milliseconds for all requests. When set, requests will automatically abort after this duration to prevent indefinite hangs." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 104, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L104" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 33, "name": "urlLengthLimit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Maximum URL length in characters before warnings/errors are triggered. Defaults to 8000." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 105, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L105" } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "8000" } ], "groups": [ { "title": "Properties", "children": [24, 22, 23, 32, 33] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 100, "character": 7, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L100" } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": 9, "typeArguments": [ { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true }, { "type": "reference", "target": 13, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 17, "name": "SchemaName", "package": "@supabase/postgrest-js", "qualifiedName": "default.SchemaName", "refersToTypeParameter": true }, { "type": "reference", "target": 18, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true } ], "name": "PostgrestClient", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 37, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 40, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L40" } ], "type": { "type": "reflection", "declaration": { "id": 38, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 39, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 40, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" } ] } }, { "id": 41, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 42, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 43, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" } ] } }, { "id": 44, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 35, "name": "headers", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 38, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L38" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" } }, { "id": 36, "name": "schemaName", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 39, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L39" } ], "type": { "type": "reference", "target": 17, "name": "SchemaName", "package": "@supabase/postgrest-js", "qualifiedName": "default.SchemaName", "refersToTypeParameter": true } }, { "id": 34, "name": "url", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 37, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L37" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 45, "name": "urlLengthLimit", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 41, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L41" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 46, "name": "from", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Perform a query on a table or a view." } ], "blockTags": [ { "tag": "@param", "name": "relation", "content": [ { "kind": "text", "text": "The table or view name to query" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 155, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L155" }, { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 159, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L159" }, { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 169, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L169" } ], "signatures": [ { "id": 47, "name": "from", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 155, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L155" } ], "typeParameters": [ { "id": 48, "name": "TableName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 49, "name": "Table", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericTable" }, "name": "GenericTable", "package": "@supabase/postgrest-js" } } ], "parameters": [ { "id": 50, "name": "relation", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 48, "name": "TableName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 78, "typeArguments": [ { "type": "reference", "target": 13, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 18, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 49, "name": "Table", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 48, "name": "TableName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "PostgrestQueryBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } }, { "id": 51, "name": "from", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 159, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L159" } ], "typeParameters": [ { "id": 52, "name": "ViewName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 53, "name": "View", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericView" }, "name": "GenericView", "package": "@supabase/postgrest-js" } } ], "parameters": [ { "id": 54, "name": "relation", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 52, "name": "ViewName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 78, "typeArguments": [ { "type": "reference", "target": 13, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 18, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 53, "name": "View", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 52, "name": "ViewName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "PostgrestQueryBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 59, "name": "rpc", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 375, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L375" } ], "signatures": [ { "id": 60, "name": "rpc", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Perform a function call." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\n// For cross-schema functions where type inference fails, use overrideTypes:\nconst { data } = await supabase\n .schema('schema_b')\n .rpc('function_a', {})\n .overrideTypes<{ id: string; user_id: string }[]>()\n```" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "Call a Postgres function without arguments", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase.rpc('hello_world')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Call a Postgres function without arguments\n" }, { "kind": "code", "text": "```sql\ncreate function hello_world() returns text as $$\n select 'Hello world';\n$$ language sql;\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Call a Postgres function without arguments\n" }, { "kind": "code", "text": "```json\n{\n \"data\": \"Hello world\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@example", "name": "Call a Postgres function with arguments", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase.rpc('echo', { say: '👋' })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Call a Postgres function with arguments\n" }, { "kind": "code", "text": "```sql\ncreate function echo(say text) returns text as $$\n select say;\n$$ language sql;\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Call a Postgres function with arguments\n" }, { "kind": "code", "text": "```json\n {\n \"data\": \"👋\",\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Bulk processing\nYou can process large payloads by passing in an array as an argument." } ] }, { "tag": "@example", "name": "Bulk processing", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase.rpc('add_one_each', { arr: [1, 2, 3] })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Bulk processing\n" }, { "kind": "code", "text": "```sql\ncreate function add_one_each(arr int[]) returns int[] as $$\n select array_agg(n + 1) from unnest(arr) as n;\n$$ language sql;\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Bulk processing\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n 2,\n 3,\n 4\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Call a Postgres function with filters\nPostgres functions that return tables can also be combined with [Filters](/docs/reference/javascript/using-filters) and [Modifiers](/docs/reference/javascript/using-modifiers)." } ] }, { "tag": "@example", "name": "Call a Postgres function with filters", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .rpc('list_stored_countries')\n .eq('id', 1)\n .single()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Call a Postgres function with filters\n" }, { "kind": "code", "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Rohan'),\n (2, 'The Shire');\n\ncreate function list_stored_countries() returns setof countries as $$\n select * from countries;\n$$ language sql;\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Call a Postgres function with filters\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"id\": 1,\n \"name\": \"Rohan\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@example", "name": "Call a read-only Postgres function", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase.rpc('hello_world', undefined, { get: true })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Call a read-only Postgres function\n" }, { "kind": "code", "text": "```sql\ncreate function hello_world() returns text as $$\n select 'Hello world';\n$$ language sql;\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Call a read-only Postgres function\n" }, { "kind": "code", "text": "```json\n{\n \"data\": \"Hello world\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 375, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L375" } ], "typeParameters": [ { "id": 61, "name": "FnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 62, "name": "Args", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" }, "default": { "type": "intrinsic", "name": "never" } }, { "id": 63, "name": "FilterBuilder", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/rpc.ts", "qualifiedName": "RpcFunctionNotFound" }, "typeArguments": [ { "type": "reference", "target": 61, "name": "FnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "RpcFunctionNotFound", "package": "@supabase/postgrest-js" }, "default": { "type": "reference", "target": { "sourceFileName": "src/types/common/rpc.ts", "qualifiedName": "GetRpcFunctionFilterBuilderByArgs" }, "typeArguments": [ { "type": "reference", "target": 18, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 61, "name": "FnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 62, "name": "Args", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "GetRpcFunctionFilterBuilderByArgs", "package": "@supabase/postgrest-js" } } ], "parameters": [ { "id": 64, "name": "fn", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The function name to call" } ] }, "type": { "type": "reference", "target": 61, "name": "FnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 65, "name": "args", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The arguments to pass to the function call" } ] }, "type": { "type": "reference", "target": 62, "name": "Args", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "defaultValue": "..." }, { "id": 66, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 67, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 70, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Count algorithm to use to count rows returned by the\nfunction. Only applicable for [set-returning\nfunctions](https://www.postgresql.org/docs/current/functions-srf.html).\n\n" }, { "kind": "code", "text": "`\"exact\"`" }, { "kind": "text", "text": ": Exact but slow count algorithm. Performs a " }, { "kind": "code", "text": "`COUNT(*)`" }, { "kind": "text", "text": " under the\nhood.\n\n" }, { "kind": "code", "text": "`\"planned\"`" }, { "kind": "text", "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" }, { "kind": "code", "text": "`\"estimated\"`" }, { "kind": "text", "text": ": Uses exact count for low numbers and planned count for high\nnumbers." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 393, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L393" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 69, "name": "get", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "When set to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", the function will be called with\nread-only access mode." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 392, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L392" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 68, "name": "head", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "When set to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " will not be returned.\nUseful if you only need the count." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 391, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L391" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "groups": [ { "title": "Properties", "children": [70, 69, 68] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 390, "character": 7, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L390" } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 13, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 18, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "target": 63, "name": "FilterBuilder", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Result" }, "objectType": { "type": "reference", "target": 63, "name": "FilterBuilder", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "RelationName" }, "objectType": { "type": "reference", "target": 63, "name": "FilterBuilder", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Relationships" }, "objectType": { "type": "reference", "target": 63, "name": "FilterBuilder", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "type": "literal", "value": "RPC" } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 55, "name": "schema", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 194, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L194" } ], "signatures": [ { "id": 56, "name": "schema", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Select a schema to query or perform an function (rpc) call.\n\nThe schema needs to be on the list of exposed schemas inside Supabase." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 194, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L194" } ], "typeParameters": [ { "id": 57, "name": "DynamicSchema", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 58, "name": "schema", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The schema to query" } ] }, "type": { "type": "reference", "target": 57, "name": "DynamicSchema", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 9, "typeArguments": [ { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true }, { "type": "reference", "target": 13, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 57, "name": "DynamicSchema", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 57, "name": "DynamicSchema", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true } }, "extendsType": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "intrinsic", "name": "any" }, "objectType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "intrinsic", "name": "any" } } ], "name": "PostgrestClient", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] } ], "groups": [ { "title": "Constructors", "children": [10] }, { "title": "Properties", "children": [37, 35, 36, 34, 45] }, { "title": "Methods", "children": [46, 59, 55] } ], "categories": [ { "title": "Database", "children": [10, 46, 59, 55] }, { "title": "Other", "children": [37, 35, 36, 34, 45] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 16, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L16" } ], "typeParameters": [ { "id": 71, "name": "Database", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Types for the schema from the [type\ngenerator](https://supabase.com/docs/reference/javascript/next/typescript-support)" } ] }, "default": { "type": "intrinsic", "name": "any" } }, { "id": 72, "name": "ClientOptions", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" }, "default": { "type": "conditional", "checkType": { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true }, "extendsType": { "type": "reflection", "declaration": { "id": 73, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 74, "name": "__InternalSupabase", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 19, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L19" } ], "type": { "type": "inferred", "name": "I", "constraint": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" } } } ], "groups": [ { "title": "Properties", "children": [74] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 18, "character": 63, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L18" } ] } }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "I" }, "name": "I", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "reflection", "declaration": { "id": 75, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestClient.ts", "line": 22, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestClient.ts#L22" } ] } } } }, { "id": 76, "name": "SchemaName", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Postgres schema to switch to. Must be a string\nliteral, the same one passed to the constructor. If the schema is not\n" }, { "kind": "code", "text": "`\"public\"`" }, { "kind": "text", "text": ", this must be supplied manually." } ] }, "type": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true }, { "type": "literal", "value": "__InternalSupabase" } ], "name": "Omit", "package": "typescript" } } ] }, "default": { "type": "conditional", "checkType": { "type": "literal", "value": "public" }, "extendsType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true }, { "type": "literal", "value": "__InternalSupabase" } ], "name": "Omit", "package": "typescript" } }, "trueType": { "type": "literal", "value": "public" }, "falseType": { "type": "intersection", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true }, { "type": "literal", "value": "__InternalSupabase" } ], "name": "Omit", "package": "typescript" } } ] } } }, { "id": 77, "name": "Schema", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" }, "default": { "type": "conditional", "checkType": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 17, "name": "SchemaName", "package": "@supabase/postgrest-js", "qualifiedName": "default.SchemaName", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true }, { "type": "literal", "value": "__InternalSupabase" } ], "name": "Omit", "package": "typescript" } }, "extendsType": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" }, "trueType": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 17, "name": "SchemaName", "package": "@supabase/postgrest-js", "qualifiedName": "default.SchemaName", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", "target": 12, "name": "Database", "package": "@supabase/postgrest-js", "qualifiedName": "default.Database", "refersToTypeParameter": true }, { "type": "literal", "value": "__InternalSupabase" } ], "name": "Omit", "package": "typescript" } }, "falseType": { "type": "intrinsic", "name": "any" } } } ] }, { "id": 819, "name": "PostgrestError", "variant": "declaration", "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Error format\n\n" }, { "kind": "inline-tag", "tag": "@link", "text": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes", "target": "https://postgrest.org/en/stable/api.html?highlight=options#errors-and-http-status-codes" } ] }, "children": [ { "id": 820, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", "line": 24, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestError.ts#L24" } ], "signatures": [ { "id": 821, "name": "PostgrestError", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport PostgrestError from '@supabase/postgrest-js'\n\nthrow new PostgrestError({\n message: 'Row level security prevented the request',\n details: 'RLS denied the insert',\n hint: 'Check your policies',\n code: 'PGRST301',\n})\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", "line": 24, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestError.ts#L24" } ], "parameters": [ { "id": 822, "name": "context", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 823, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 827, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", "line": 24, "character": 73, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestError.ts#L24" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 825, "name": "details", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", "line": 24, "character": 42, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestError.ts#L24" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 826, "name": "hint", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", "line": 24, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestError.ts#L24" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 824, "name": "message", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", "line": 24, "character": 25, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestError.ts#L24" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [827, 825, 826, 824] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", "line": 24, "character": 23, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestError.ts#L24" } ] } } } ], "type": { "type": "reference", "target": 819, "name": "PostgrestError", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "overwrites": { "type": "reference", "target": -1, "name": "Error.constructor" } } ], "overwrites": { "type": "reference", "target": -1, "name": "Error.constructor" } }, { "id": 830, "name": "code", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", "line": 9, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestError.ts#L9" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 828, "name": "details", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", "line": 7, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestError.ts#L7" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 829, "name": "hint", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", "line": 8, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestError.ts#L8" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Constructors", "children": [820] }, { "title": "Properties", "children": [830, 828, 829] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestError.ts", "line": 6, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestError.ts#L6" } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Error" }, "name": "Error", "package": "typescript" } ] }, { "id": 180, "name": "PostgrestFilterBuilder", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { "id": 181, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 57, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L57" } ], "signatures": [ { "id": 182, "name": "PostgrestFilterBuilder", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a builder configured for a specific PostgREST request." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'public-anon-key' }) }\n)\n```" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "Creating a Postgrest query builder", "content": [ { "kind": "code", "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'public-anon-key' }) }\n)\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 57, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L57" } ], "typeParameters": [ { "id": 183, "name": "ClientOptions", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" } }, { "id": 184, "name": "Schema", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" } }, { "id": 185, "name": "Row", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } }, { "id": 186, "name": "Result", "variant": "typeParam", "kind": 131072, "flags": {} }, { "id": 187, "name": "RelationName", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 188, "name": "Relationships", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 189, "name": "Method", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "parameters": [ { "id": 190, "name": "builder", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 191, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 196, "name": "body", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 62, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L62" } ], "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 199, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 65, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L65" } ], "type": { "type": "reflection", "declaration": { "id": 200, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 201, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 202, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" } ] } }, { "id": 203, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 204, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 205, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" } ] } }, { "id": 206, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 194, "name": "headers", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 60, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L60" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "HeadersInit" }, "name": "HeadersInit", "package": "typescript" } }, { "id": 207, "name": "isMaybeSingle", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 66, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L66" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 192, "name": "method", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 58, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L58" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] } }, { "id": 195, "name": "schema", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 61, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L61" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 197, "name": "shouldThrowOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 63, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L63" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 198, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 64, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L64" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" } }, { "id": 193, "name": "url", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 59, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L59" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } }, { "id": 208, "name": "urlLengthLimit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 67, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L67" } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [196, 199, 194, 207, 192, 195, 197, 198, 193, 208] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 57, "character": 23, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L57" } ] } } } ], "type": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 187, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 188, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 189, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": 586, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", "target": 585, "name": "default.constructor" } }, { "id": 538, "name": "body", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isOptional": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 25, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L25" } ], "type": { "type": "intrinsic", "name": "unknown" }, "inheritedFrom": { "type": "reference", "target": 699, "name": "default.body" } }, { "id": 541, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 28, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L28" } ], "type": { "type": "reflection", "declaration": { "id": 542, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 543, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 544, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" } ] } }, { "id": 545, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 546, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 547, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" } ] } }, { "id": 548, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } }, "inheritedFrom": { "type": "reference", "target": 702, "name": "default.fetch" } }, { "id": 536, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 23, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L23" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 697, "name": "default.headers" } }, { "id": 549, "name": "isMaybeSingle", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 29, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L29" } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "target": 710, "name": "default.isMaybeSingle" } }, { "id": 534, "name": "method", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 21, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] }, "inheritedFrom": { "type": "reference", "target": 695, "name": "default.method" } }, { "id": 537, "name": "schema", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isOptional": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 24, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L24" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 698, "name": "default.schema" } }, { "id": 539, "name": "shouldThrowOnError", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 26, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L26" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false", "inheritedFrom": { "type": "reference", "target": 700, "name": "default.shouldThrowOnError" } }, { "id": 540, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isOptional": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 27, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L27" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 701, "name": "default.signal" } }, { "id": 535, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 22, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L22" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 696, "name": "default.url" } }, { "id": 550, "name": "urlLengthLimit", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 30, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L30" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 711, "name": "default.urlLengthLimit" } }, { "id": 503, "name": "abortSignal", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 593, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L593" } ], "signatures": [ { "id": 504, "name": "abortSignal", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Set the AbortSignal for the fetch request." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "You can use this to set a timeout for the request." } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Aborting requests in-flight\nYou can use an [" }, { "kind": "code", "text": "`AbortController`" }, { "kind": "text", "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " }, { "kind": "code", "text": "`status`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`statusText`" }, { "kind": "text", "text": " don't mean anything for aborted requests as the request wasn't fulfilled." } ] }, { "tag": "@example", "name": "Aborting requests in-flight", "content": [ { "kind": "code", "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Aborting requests in-flight\n" }, { "kind": "code", "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" } ] }, { "tag": "@example", "name": "Set a timeout", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Set a timeout\n" }, { "kind": "code", "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 593, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L593" } ], "parameters": [ { "id": 505, "name": "signal", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The AbortSignal to use for the fetch request" } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 665, "name": "default.abortSignal" } } ], "inheritedFrom": { "type": "reference", "target": 664, "name": "default.abortSignal" } }, { "id": 347, "name": "containedBy", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Only relevant for jsonb, array, and range columns. Match only rows where\nevery element appearing in " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is contained by " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The jsonb, array, or range column to filter on" } ] }, { "tag": "@param", "name": "value", "content": [ { "kind": "text", "text": "The jsonb, array, or range value to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "On array columns", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('classes')\n .select('name')\n .containedBy('days', ['monday', 'tuesday', 'wednesday', 'friday'])\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On array columns\n" }, { "kind": "code", "text": "```sql\ncreate table\n classes (\n id int8 primary key,\n name text,\n days text[]\n );\n\ninsert into\n classes (id, name, days)\nvalues\n (1, 'Chemistry', array['monday', 'friday']),\n (2, 'History', array['monday', 'wednesday', 'thursday']);\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On array columns\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Chemistry\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." } ] }, { "tag": "@example", "name": "On range columns", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .containedBy('during', '[2000-01-01 00:00, 2000-01-01 23:59)')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On range columns\n" }, { "kind": "code", "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On range columns\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@example", "name": "On `jsonb` columns", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select('name')\n .containedBy('address', {})\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On " }, { "kind": "code", "text": "`jsonb`" }, { "kind": "text", "text": " columns\n" }, { "kind": "code", "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210, \"street\": \"Melrose Place\" }'),\n (2, 'Jane', '{}');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On " }, { "kind": "code", "text": "`jsonb`" }, { "kind": "text", "text": " columns\n" }, { "kind": "code", "text": "```json\n {\n \"data\": [\n {\n \"name\": \"Jane\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 969, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L969" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 973, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L973" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1103, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1103" } ], "signatures": [ { "id": 348, "name": "containedBy", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 969, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L969" } ], "typeParameters": [ { "id": 349, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 350, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 349, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 351, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 349, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } } } } ] } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 352, "name": "containedBy", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 973, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L973" } ], "parameters": [ { "id": 353, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 354, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 339, "name": "contains", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Only relevant for jsonb, array, and range columns. Match only rows where\n" }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " contains every element appearing in " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The jsonb, array, or range column to filter on" } ] }, { "tag": "@param", "name": "value", "content": [ { "kind": "text", "text": "The jsonb, array, or range value to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "On array columns", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('issues')\n .select()\n .contains('tags', ['is:open', 'priority:low'])\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On array columns\n" }, { "kind": "code", "text": "```sql\ncreate table\n issues (\n id int8 primary key,\n title text,\n tags text[]\n );\n\ninsert into\n issues (id, title, tags)\nvalues\n (1, 'Cache invalidation is not working', array['is:open', 'severity:high', 'priority:low']),\n (2, 'Use better names', array['is:open', 'severity:low', 'priority:medium']);\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On array columns\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"title\": \"Cache invalidation is not working\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." } ] }, { "tag": "@example", "name": "On range columns", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .contains('during', '[2000-01-01 13:00, 2000-01-01 13:30)')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On range columns\n" }, { "kind": "code", "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On range columns\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@example", "name": "On `jsonb` columns", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select('name')\n .contains('address', { postcode: 90210 })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On " }, { "kind": "code", "text": "`jsonb`" }, { "kind": "text", "text": " columns\n" }, { "kind": "code", "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210, \"street\": \"Melrose Place\" }'),\n (2, 'Jane', '{}');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On " }, { "kind": "code", "text": "`jsonb`" }, { "kind": "text", "text": " columns\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Michael\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 821, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L821" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 825, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L825" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 954, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L954" } ], "signatures": [ { "id": 340, "name": "contains", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 821, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L821" } ], "typeParameters": [ { "id": 341, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 342, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 341, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 343, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 341, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } } } } ] } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 344, "name": "contains", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 825, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L825" } ], "parameters": [ { "id": 345, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 346, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 512, "name": "csv", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 732, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L732" } ], "signatures": [ { "id": 513, "name": "csv", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Return " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " as a string in CSV format." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." } ] }, { "tag": "@example", "name": "Return data as CSV", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Return data as CSV\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Return data as CSV\n" }, { "kind": "code", "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 732, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L732" } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "string" } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": 674, "name": "default.csv" } } ], "inheritedFrom": { "type": "reference", "target": 673, "name": "default.csv" } }, { "id": 209, "name": "eq", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 141, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L141" } ], "signatures": [ { "id": 210, "name": "eq", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is equal to " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": ".\n\nTo check if the value of " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is NULL, you should use " }, { "kind": "code", "text": "`.is()`" }, { "kind": "text", "text": " instead." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Leia')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 141, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L141" } ], "typeParameters": [ { "id": 211, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 212, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The column to filter on" } ] }, "type": { "type": "conditional", "checkType": { "type": "reference", "target": 211, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } }, "trueType": { "type": "reference", "target": 211, "typeArguments": [ { "type": "reference", "target": 211, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "target": 211, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "union", "types": [ { "type": "templateLiteral", "head": "", "tail": [ [ { "type": "intrinsic", "name": "string" }, "->" ], [ { "type": "intrinsic", "name": "string" }, "" ] ] }, { "type": "templateLiteral", "head": "", "tail": [ [ { "type": "intrinsic", "name": "string" }, "." ], [ { "type": "intrinsic", "name": "string" }, "" ] ] } ] }, "trueType": { "type": "reference", "target": 211, "typeArguments": [ { "type": "reference", "target": 211, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "conditional", "checkType": { "type": "intrinsic", "name": "string" }, "extendsType": { "type": "reference", "target": 211, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "trueType": { "type": "reference", "target": 211, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } } } } } }, { "id": 213, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The value to filter with" } ] }, "type": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolveFilterValue" }, "typeArguments": [ { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 211, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ResolveFilterValue", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "intrinsic", "name": "never" }, "trueType": { "type": "reflection", "declaration": { "id": 214, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {} } }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolveFilterValue" }, "typeArguments": [ { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 211, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ResolveFilterValue", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolvedFilterValue" }, "name": "ResolvedFilterValue", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "trueType": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "NonNullable" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolvedFilterValue" }, "name": "ResolvedFilterValue", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "NonNullable", "package": "typescript" }, "falseType": { "type": "intrinsic", "name": "never" } } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 516, "name": "explain", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 842, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L842" } ], "signatures": [ { "id": 517, "name": "explain", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Return " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " }, { "kind": "code", "text": "`format`" }, { "kind": "text", "text": " parameter." } ] }, { "tag": "@example", "name": "Get the execution plan", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Get the execution plan\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Get the execution plan\n" }, { "kind": "code", "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " }, { "kind": "code", "text": "`format`" }, { "kind": "text", "text": " parameter." } ] }, { "tag": "@example", "name": "Get the execution plan with analyze and verbose", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Get the execution plan with analyze and verbose\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Get the execution plan with analyze and verbose\n" }, { "kind": "code", "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 842, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L842" } ], "parameters": [ { "id": 518, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 519, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 520, "name": "analyze", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", the query will be executed and the\nactual run time will be returned" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 850, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L850" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 523, "name": "buffers", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", include information on buffer usage" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 853, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L853" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 525, "name": "format", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The format of the output, can be " }, { "kind": "code", "text": "`\"text\"`" }, { "kind": "text", "text": " (default)\nor " }, { "kind": "code", "text": "`\"json\"`" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 855, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L855" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "text" }, { "type": "literal", "value": "json" } ] }, "defaultValue": "'text'" }, { "id": 522, "name": "settings", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", include information on configuration\nparameters that affect query planning" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 852, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L852" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 521, "name": "verbose", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", the query identifier will be returned\nand " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " will include the output columns of the query" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 851, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 524, "name": "wal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", include information on WAL record generation" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 854, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L854" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "groups": [ { "title": "Properties", "children": [520, 523, 525, 522, 521, 524] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 849, "character": 5, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L849" } ] } }, "defaultValue": "{}" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": false } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } }, { "type": "literal", "value": false } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } ] }, "inheritedFrom": { "type": "reference", "target": 678, "name": "default.explain" } } ], "inheritedFrom": { "type": "reference", "target": 677, "name": "default.explain" } }, { "id": 442, "name": "filter", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows which satisfy the filter. This is an escape hatch - you\nshould use the specific filter methods wherever possible.\n\nUnlike most filters, " }, { "kind": "code", "text": "`opearator`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "operator", "content": [ { "kind": "text", "text": "The operator to filter with, following PostgREST syntax" } ] }, { "tag": "@param", "name": "value", "content": [ { "kind": "text", "text": "The value to filter with, following PostgREST syntax" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "filter() expects you to use the raw PostgREST syntax for the filter values.\n\n" }, { "kind": "code", "text": "```ts\n.filter('id', 'in', '(5,6,7)') // Use `()` for `in` filter\n.filter('arraycol', 'cs', '{\"a\",\"b\"}') // Use `cs` for `contains()`, `{}` for array values\n```" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .filter('name', 'in', '(\"Han\",\"Yoda\")')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@example", "name": "On a referenced table", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .filter('instruments.name', 'eq', 'flute')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On a referenced table\n" }, { "kind": "code", "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On a referenced table\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"woodwinds\",\n \"instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1953, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1953" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1958, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1958" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 2071, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2071" } ], "signatures": [ { "id": 443, "name": "filter", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1953, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1953" } ], "typeParameters": [ { "id": 444, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 445, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 444, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 446, "name": "operator", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "FilterOperator" }, "name": "FilterOperator", "package": "@supabase/postgrest-js" }, { "type": "literal", "value": "not.match" }, { "type": "literal", "value": "not.eq" }, { "type": "literal", "value": "not.neq" }, { "type": "literal", "value": "not.gt" }, { "type": "literal", "value": "not.gte" }, { "type": "literal", "value": "not.lt" }, { "type": "literal", "value": "not.lte" }, { "type": "literal", "value": "not.like" }, { "type": "literal", "value": "not.ilike" }, { "type": "literal", "value": "not.is" }, { "type": "literal", "value": "not.isdistinct" }, { "type": "literal", "value": "not.in" }, { "type": "literal", "value": "not.cs" }, { "type": "literal", "value": "not.cd" }, { "type": "literal", "value": "not.sl" }, { "type": "literal", "value": "not.sr" }, { "type": "literal", "value": "not.nxl" }, { "type": "literal", "value": "not.nxr" }, { "type": "literal", "value": "not.adj" }, { "type": "literal", "value": "not.ov" }, { "type": "literal", "value": "not.fts" }, { "type": "literal", "value": "not.plfts" }, { "type": "literal", "value": "not.phfts" }, { "type": "literal", "value": "not.wfts" }, { "type": "literal", "value": "not.imatch" } ] } }, { "id": 447, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 448, "name": "filter", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1958, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1958" } ], "parameters": [ { "id": 449, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 450, "name": "operator", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 451, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 514, "name": "geojson", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 742, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L742" } ], "signatures": [ { "id": 515, "name": "geojson", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Return " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " as an object in [GeoJSON](https://geojson.org) format." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 742, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L742" } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": 676, "name": "default.geojson" } } ], "inheritedFrom": { "type": "reference", "target": 675, "name": "default.geojson" } }, { "id": 220, "name": "gt", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is greater than " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "value", "content": [ { "kind": "text", "text": "The value to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\nWhen using [reserved words](https://www.postgresql.org/docs/current/sql-keywords-appendix.html) for column names you need\nto add double quotes e.g. " }, { "kind": "code", "text": "`.gt('\"order\"', 2)`" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .gt('id', 2)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 224, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L224" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 225, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L225" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 273, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L273" } ], "signatures": [ { "id": 221, "name": "gt", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 224, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L224" } ], "typeParameters": [ { "id": 222, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 223, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 222, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 224, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 222, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 225, "name": "gt", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 225, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L225" } ], "parameters": [ { "id": 226, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 227, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 228, "name": "gte", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is greater than or equal to " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "value", "content": [ { "kind": "text", "text": "The value to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .gte('id', 2)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 278, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L278" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 279, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L279" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 327, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L327" } ], "signatures": [ { "id": 229, "name": "gte", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 278, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L278" } ], "typeParameters": [ { "id": 230, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 231, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 230, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 232, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 230, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 233, "name": "gte", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 279, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L279" } ], "parameters": [ { "id": 234, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 235, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 276, "name": "ilike", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " matches " }, { "kind": "code", "text": "`pattern`" }, { "kind": "text", "text": " case-insensitively." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "pattern", "content": [ { "kind": "text", "text": "The pattern to match with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .ilike('name', '%lu%')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 522, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L522" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 523, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L523" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 567, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L567" } ], "signatures": [ { "id": 277, "name": "ilike", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 522, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L522" } ], "typeParameters": [ { "id": 278, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 279, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 278, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 280, "name": "pattern", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 281, "name": "ilike", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 523, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L523" } ], "parameters": [ { "id": 282, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 283, "name": "pattern", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 284, "name": "ilikeAllOf", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " matches all of " }, { "kind": "code", "text": "`patterns`" }, { "kind": "text", "text": " case-insensitively." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "patterns", "content": [ { "kind": "text", "text": "The patterns to match with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 572, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L572" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 576, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L576" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 585, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L585" } ], "signatures": [ { "id": 285, "name": "ilikeAllOf", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 572, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L572" } ], "typeParameters": [ { "id": 286, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 287, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 286, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 288, "name": "patterns", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 289, "name": "ilikeAllOf", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 576, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L576" } ], "parameters": [ { "id": 290, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 291, "name": "patterns", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 292, "name": "ilikeAnyOf", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " matches any of " }, { "kind": "code", "text": "`patterns`" }, { "kind": "text", "text": " case-insensitively." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "patterns", "content": [ { "kind": "text", "text": "The patterns to match with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 590, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L590" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 594, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L594" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 603, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L603" } ], "signatures": [ { "id": 293, "name": "ilikeAnyOf", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 590, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L590" } ], "typeParameters": [ { "id": 294, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 295, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 294, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 296, "name": "patterns", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 297, "name": "ilikeAnyOf", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 594, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L594" } ], "parameters": [ { "id": 298, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 299, "name": "patterns", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 329, "name": "in", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 768, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L768" } ], "signatures": [ { "id": 330, "name": "in", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is included in the " }, { "kind": "code", "text": "`values`" }, { "kind": "text", "text": " array." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .in('name', ['Leia', 'Han'])\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 768, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L768" } ], "typeParameters": [ { "id": 331, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 332, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The column to filter on" } ] }, "type": { "type": "reference", "target": 331, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 333, "name": "values", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The values array to filter with" } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolveFilterValue" }, "typeArguments": [ { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 331, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ResolveFilterValue", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "intrinsic", "name": "never" }, "trueType": { "type": "intrinsic", "name": "unknown" }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolveFilterValue" }, "typeArguments": [ { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 331, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ResolveFilterValue", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolvedFilterValue" }, "name": "ResolvedFilterValue", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolvedFilterValue" }, "name": "ResolvedFilterValue", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "intrinsic", "name": "never" } } } } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 316, "name": "is", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " IS " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": ".\n\nFor non-boolean columns, this is only relevant for checking if the value of\n" }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is NULL by setting " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": " to " }, { "kind": "code", "text": "`null`" }, { "kind": "text", "text": ".\n\nFor boolean columns, you can also set " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": " to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": " and it\nwill behave the same way as " }, { "kind": "code", "text": "`.eq()`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "value", "content": [ { "kind": "text", "text": "The value to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Checking for nullness, true or false\nUsing the " }, { "kind": "code", "text": "`eq()`" }, { "kind": "text", "text": " filter doesn't work when filtering for " }, { "kind": "code", "text": "`null`" }, { "kind": "text", "text": ".\n\nInstead, you need to use " }, { "kind": "code", "text": "`is()`" }, { "kind": "text", "text": "." } ] }, { "tag": "@example", "name": "Checking for nullness, true or false", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .select()\n .is('name', null)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Checking for nullness, true or false\n" }, { "kind": "code", "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'null'),\n (2, null);\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Checking for nullness, true or false\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"null\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 636, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L636" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 640, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L640" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 694, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L694" } ], "signatures": [ { "id": 317, "name": "is", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 636, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L636" } ], "typeParameters": [ { "id": 318, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 319, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 318, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 320, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intersection", "types": [ { "type": "indexedAccess", "indexType": { "type": "reference", "target": 318, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } }, { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "boolean" } ] } ] } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 321, "name": "is", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 640, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L640" } ], "parameters": [ { "id": 322, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 323, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "boolean" } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 324, "name": "isDistinct", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 709, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L709" } ], "signatures": [ { "id": 325, "name": "isDistinct", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " IS DISTINCT FROM " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": ".\n\nUnlike " }, { "kind": "code", "text": "`.neq()`" }, { "kind": "text", "text": ", this treats " }, { "kind": "code", "text": "`NULL`" }, { "kind": "text", "text": " as a comparable value. Two " }, { "kind": "code", "text": "`NULL`" }, { "kind": "text", "text": " values\nare considered equal (not distinct), and comparing " }, { "kind": "code", "text": "`NULL`" }, { "kind": "text", "text": " with any non-NULL\nvalue returns true (distinct)." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 709, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L709" } ], "typeParameters": [ { "id": 326, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 327, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The column to filter on" } ] }, "type": { "type": "reference", "target": 326, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 328, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The value to filter with" } ] }, "type": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolveFilterValue" }, "typeArguments": [ { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 326, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ResolveFilterValue", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "intrinsic", "name": "never" }, "trueType": { "type": "intrinsic", "name": "unknown" }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolveFilterValue" }, "typeArguments": [ { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 326, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ResolveFilterValue", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolvedFilterValue" }, "name": "ResolvedFilterValue", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolvedFilterValue" }, "name": "ResolvedFilterValue", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "intrinsic", "name": "never" } } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 252, "name": "like", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " matches " }, { "kind": "code", "text": "`pattern`" }, { "kind": "text", "text": " case-sensitively." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "pattern", "content": [ { "kind": "text", "text": "The pattern to match with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .like('name', '%Lu%')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 436, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L436" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 437, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L437" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 481, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L481" } ], "signatures": [ { "id": 253, "name": "like", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 436, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L436" } ], "typeParameters": [ { "id": 254, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 255, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 254, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 256, "name": "pattern", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 257, "name": "like", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 437, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L437" } ], "parameters": [ { "id": 258, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 259, "name": "pattern", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 260, "name": "likeAllOf", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " matches all of " }, { "kind": "code", "text": "`patterns`" }, { "kind": "text", "text": " case-sensitively." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "patterns", "content": [ { "kind": "text", "text": "The patterns to match with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 486, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L486" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 490, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L490" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 499, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L499" } ], "signatures": [ { "id": 261, "name": "likeAllOf", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 486, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L486" } ], "typeParameters": [ { "id": 262, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 263, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 262, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 264, "name": "patterns", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 265, "name": "likeAllOf", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 490, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L490" } ], "parameters": [ { "id": 266, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 267, "name": "patterns", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 268, "name": "likeAnyOf", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " matches any of " }, { "kind": "code", "text": "`patterns`" }, { "kind": "text", "text": " case-sensitively." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "patterns", "content": [ { "kind": "text", "text": "The patterns to match with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 504, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L504" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 508, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L508" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 517, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L517" } ], "signatures": [ { "id": 269, "name": "likeAnyOf", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 504, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L504" } ], "typeParameters": [ { "id": 270, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 271, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 270, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 272, "name": "patterns", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 273, "name": "likeAnyOf", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 508, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L508" } ], "parameters": [ { "id": 274, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 275, "name": "patterns", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "string" } } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 488, "name": "limit", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 445, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L445" } ], "signatures": [ { "id": 489, "name": "limit", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Limit the query result by " }, { "kind": "code", "text": "`count`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@example", "name": "On a referenced table", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On a referenced table\n" }, { "kind": "code", "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On a referenced table\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 445, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L445" } ], "parameters": [ { "id": 490, "name": "count", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The maximum number of rows to return" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 491, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 492, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 493, "name": "foreignTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Deprecated, use " }, { "kind": "code", "text": "`options.referencedTable`" }, { "kind": "text", "text": "\ninstead" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 450, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L450" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 494, "name": "referencedTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Set this to limit rows of referenced\ntables instead of the parent table" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 450, "character": 32, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L450" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "foreignTable" } ], "groups": [ { "title": "Properties", "children": [493, 494] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 450, "character": 7, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L450" } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 650, "name": "default.limit" } } ], "inheritedFrom": { "type": "reference", "target": 649, "name": "default.limit" } }, { "id": 236, "name": "lt", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is less than " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "value", "content": [ { "kind": "text", "text": "The value to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .lt('id', 2)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 332, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L332" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 333, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L333" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 377, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L377" } ], "signatures": [ { "id": 237, "name": "lt", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 332, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L332" } ], "typeParameters": [ { "id": 238, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 239, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 238, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 240, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 238, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 241, "name": "lt", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 333, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L333" } ], "parameters": [ { "id": 242, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 243, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 244, "name": "lte", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is less than or equal to " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "value", "content": [ { "kind": "text", "text": "The value to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .lte('id', 2)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 382, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L382" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 383, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L383" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 431, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L431" } ], "signatures": [ { "id": 245, "name": "lte", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 382, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L382" } ], "typeParameters": [ { "id": 246, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 247, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 246, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 248, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 246, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 249, "name": "lte", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 383, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L383" } ], "parameters": [ { "id": 250, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 251, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 419, "name": "match", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where each column in " }, { "kind": "code", "text": "`query`" }, { "kind": "text", "text": " keys is equal to its\nassociated value. Shorthand for multiple " }, { "kind": "code", "text": "`.eq()`" }, { "kind": "text", "text": "s." } ], "blockTags": [ { "tag": "@param", "name": "query", "content": [ { "kind": "text", "text": "The object to filter with, with column names as keys mapped\nto their filter values" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .match({ id: 2, name: 'Leia' })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1666, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1666" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1667, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1667" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1711, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1711" } ], "signatures": [ { "id": 420, "name": "match", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1666, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1666" } ], "typeParameters": [ { "id": 421, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 422, "name": "query", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "reference", "target": 421, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "indexedAccess", "indexType": { "type": "reference", "target": 421, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } } ], "name": "Record", "package": "typescript" } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 423, "name": "match", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1667, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1667" } ], "parameters": [ { "id": 424, "name": "query", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 531, "name": "maxAffected", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 957, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L957" } ], "signatures": [ { "id": 532, "name": "maxAffected", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 957, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L957" } ], "parameters": [ { "id": 533, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The maximum number of rows that can be affected" } ] }, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/types/feature-flags.ts", "qualifiedName": "MaxAffectedEnabled" }, "typeArguments": [ { "type": "indexedAccess", "indexType": { "type": "literal", "value": "PostgrestVersion" }, "objectType": { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true } } ], "name": "MaxAffectedEnabled", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": 189, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true }, "extendsType": { "type": "union", "types": [ { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" }, { "type": "literal", "value": "RPC" } ] }, "trueType": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 187, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 188, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 189, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "InvalidMethodError" }, "typeArguments": [ { "type": "literal", "value": "maxAffected method only available on update or delete" } ], "name": "InvalidMethodError", "package": "@supabase/postgrest-js" } }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "InvalidMethodError" }, "typeArguments": [ { "type": "literal", "value": "maxAffected method only available on postgrest 13+" } ], "name": "InvalidMethodError", "package": "@supabase/postgrest-js" } }, "inheritedFrom": { "type": "reference", "target": 693, "name": "default.maxAffected" } } ], "inheritedFrom": { "type": "reference", "target": 692, "name": "default.maxAffected" } }, { "id": 509, "name": "maybeSingle", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 685, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L685" } ], "signatures": [ { "id": 510, "name": "maybeSingle", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Return " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " }, { "kind": "code", "text": "`.limit(1)`" }, { "kind": "text", "text": "), otherwise\nthis returns an error." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 685, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L685" } ], "typeParameters": [ { "id": 511, "name": "ResultOne", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, "extendsType": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": 511, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ] } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": 671, "name": "default.maybeSingle" } } ], "inheritedFrom": { "type": "reference", "target": 670, "name": "default.maybeSingle" } }, { "id": 215, "name": "neq", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 206, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L206" } ], "signatures": [ { "id": 216, "name": "neq", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is not equal to " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .neq('name', 'Leia')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Luke\"\n },\n {\n \"id\": 3,\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 206, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L206" } ], "typeParameters": [ { "id": 217, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 218, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The column to filter on" } ] }, "type": { "type": "conditional", "checkType": { "type": "reference", "target": 217, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } }, "trueType": { "type": "reference", "target": 217, "typeArguments": [ { "type": "reference", "target": 217, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "target": 217, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "union", "types": [ { "type": "templateLiteral", "head": "", "tail": [ [ { "type": "intrinsic", "name": "string" }, "->" ], [ { "type": "intrinsic", "name": "string" }, "" ] ] }, { "type": "templateLiteral", "head": "", "tail": [ [ { "type": "intrinsic", "name": "string" }, "." ], [ { "type": "intrinsic", "name": "string" }, "" ] ] } ] }, "trueType": { "type": "reference", "target": 217, "typeArguments": [ { "type": "reference", "target": 217, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "conditional", "checkType": { "type": "intrinsic", "name": "string" }, "extendsType": { "type": "reference", "target": 217, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "trueType": { "type": "reference", "target": 217, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "typeOperator", "operator": "keyof", "target": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } } } } } }, { "id": 219, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The value to filter with" } ] }, "type": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolveFilterValue" }, "typeArguments": [ { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 217, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ResolveFilterValue", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "intrinsic", "name": "never" }, "trueType": { "type": "intrinsic", "name": "unknown" }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolveFilterValue" }, "typeArguments": [ { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 217, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ResolveFilterValue", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "Resolved" }, "name": "Resolved", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "Resolved" }, "name": "Resolved", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "intrinsic", "name": "never" } } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 425, "name": "not", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows which doesn't satisfy the filter.\n\nUnlike most filters, " }, { "kind": "code", "text": "`opearator`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": " are used as-is and need to\nfollow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure they are properly sanitized." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "operator", "content": [ { "kind": "text", "text": "The operator to be negated to filter with, following\nPostgREST syntax" } ] }, { "tag": "@param", "name": "value", "content": [ { "kind": "text", "text": "The value to filter with, following PostgREST syntax" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "not() expects you to use the raw PostgREST syntax for the filter values.\n\n" }, { "kind": "code", "text": "```ts\n.not('id', 'in', '(5,6,7)') // Use `()` for `in` filter\n.not('arraycol', 'cs', '{\"a\",\"b\"}') // Use `cs` for `contains()`, `{}` for array values\n```" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .select()\n .not('name', 'is', null)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'null'),\n (2, null);\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n {\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"null\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1722, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1722" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1727, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1727" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1786, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1786" } ], "signatures": [ { "id": 426, "name": "not", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1722, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1722" } ], "typeParameters": [ { "id": 427, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 428, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 427, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 429, "name": "operator", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "FilterOperator" }, "name": "FilterOperator", "package": "@supabase/postgrest-js" } }, { "id": 430, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 427, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 431, "name": "not", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1727, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1727" } ], "parameters": [ { "id": 432, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 433, "name": "operator", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 434, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "unknown" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 334, "name": "notIn", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 799, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L799" } ], "signatures": [ { "id": 335, "name": "notIn", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is NOT included in the " }, { "kind": "code", "text": "`values`" }, { "kind": "text", "text": " array." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 799, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L799" } ], "typeParameters": [ { "id": 336, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 337, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The column to filter on" } ] }, "type": { "type": "reference", "target": 336, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 338, "name": "values", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The values array to filter with" } ] }, "type": { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolveFilterValue" }, "typeArguments": [ { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 336, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ResolveFilterValue", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "intrinsic", "name": "never" }, "trueType": { "type": "intrinsic", "name": "unknown" }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolveFilterValue" }, "typeArguments": [ { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 336, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ResolveFilterValue", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolvedFilterValue" }, "name": "ResolvedFilterValue", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ResolvedFilterValue" }, "name": "ResolvedFilterValue", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "intrinsic", "name": "never" } } } } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 435, "name": "or", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1941, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1941" } ], "signatures": [ { "id": 436, "name": "or", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows which satisfy at least one of the filters.\n\nUnlike most filters, " }, { "kind": "code", "text": "`filters`" }, { "kind": "text", "text": " is used as-is and needs to follow [PostgREST\nsyntax](https://postgrest.org/en/stable/api.html#operators). You also need\nto make sure it's properly sanitized.\n\nIt's currently not possible to do an " }, { "kind": "code", "text": "`.or()`" }, { "kind": "text", "text": " filter across multiple tables." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "or() expects you to use the raw PostgREST syntax for the filter names and values.\n\n" }, { "kind": "code", "text": "```ts\n.or('id.in.(5,6,7), arraycol.cs.{\"a\",\"b\"}') // Use `()` for `in` filter, `{}` for array values and `cs` for `contains()`.\n.or('id.in.(5,6,7), arraycol.cd.{\"a\",\"b\"}') // Use `cd` for `containedBy()`\n```" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.eq.2,name.eq.Han')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Leia\"\n },\n {\n \"name\": \"Han\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@example", "name": "Use `or` with `and`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .or('id.gt.3,and(id.eq.1,name.eq.Luke)')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Use " }, { "kind": "code", "text": "`or`" }, { "kind": "text", "text": " with " }, { "kind": "code", "text": "`and`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Use " }, { "kind": "code", "text": "`or`" }, { "kind": "text", "text": " with " }, { "kind": "code", "text": "`and`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@example", "name": "Use `or` on referenced tables", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments!inner (\n name\n )\n `)\n .or('section_id.eq.1,name.eq.guzheng', { referencedTable: 'instruments' })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Use " }, { "kind": "code", "text": "`or`" }, { "kind": "text", "text": " on referenced tables\n" }, { "kind": "code", "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Use " }, { "kind": "code", "text": "`or`" }, { "kind": "text", "text": " on referenced tables\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1941, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1941" } ], "parameters": [ { "id": 437, "name": "filters", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The filters to use, following PostgREST syntax" } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 438, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 439, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 440, "name": "foreignTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Deprecated, use " }, { "kind": "code", "text": "`referencedTable`" }, { "kind": "text", "text": " instead" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1946, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1946" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 441, "name": "referencedTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Set this to filter on referenced tables\ninstead of the parent table" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1946, "character": 32, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1946" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "foreignTable" } ], "groups": [ { "title": "Properties", "children": [440, 441] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1946, "character": 7, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1946" } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 457, "name": "order", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Order the query result by " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " }, { "kind": "code", "text": "`!inner`" }, { "kind": "text", "text": " in the query." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to order by" } ] }, { "tag": "@param", "name": "options", "content": [ { "kind": "text", "text": "Named parameters" } ] }, { "tag": "@param", "name": "options.ascending", "content": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", the result will be in ascending order" } ] }, { "tag": "@param", "name": "options.nullsFirst", "content": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`null`" }, { "kind": "text", "text": "s appear first. If " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ",\n" }, { "kind": "code", "text": "`null`" }, { "kind": "text", "text": "s appear last." } ] }, { "tag": "@param", "name": "options.referencedTable", "content": [ { "kind": "text", "text": "Set this to order a referenced table by\nits columns" } ] }, { "tag": "@param", "name": "options.foreignTable", "content": [ { "kind": "text", "text": "Deprecated, use " }, { "kind": "code", "text": "`options.referencedTable`" }, { "kind": "text", "text": "\ninstead" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('id, name')\n .order('id', { ascending: false })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "On a referenced table\nOrdering with " }, { "kind": "code", "text": "`referencedTable`" }, { "kind": "text", "text": " doesn't affect the ordering of the\nparent table." } ] }, { "tag": "@example", "name": "On a referenced table", "content": [ { "kind": "code", "text": "```ts\n const { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .order('name', { referencedTable: 'instruments', ascending: false })\n\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On a referenced table\n" }, { "kind": "code", "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On a referenced table\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n },\n {\n \"name\": \"harp\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": []\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Order parent table by a referenced table\nOrdering with " }, { "kind": "code", "text": "`referenced_table(col)`" }, { "kind": "text", "text": " affects the ordering of the\nparent table." } ] }, { "tag": "@example", "name": "Order parent table by a referenced table", "content": [ { "kind": "code", "text": "```ts\n const { data, error } = await supabase\n .from('instruments')\n .select(`\n name,\n section:orchestral_sections (\n name\n )\n `)\n .order('section(name)', { ascending: true })\n\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Order parent table by a referenced table\n" }, { "kind": "code", "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Order parent table by a referenced table\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"violin\",\n \"orchestral_sections\": {\"name\": \"strings\"}\n },\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 110, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L110" }, { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 114, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L114" }, { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 121, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L121" }, { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 128, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L128" }, { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 320, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L320" } ], "signatures": [ { "id": 458, "name": "order", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 110, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L110" } ], "typeParameters": [ { "id": 459, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 460, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 459, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 461, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 462, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 463, "name": "ascending", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 112, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L112" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 464, "name": "nullsFirst", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 112, "character": 37, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L112" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 465, "name": "referencedTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 112, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L112" } ], "type": { "type": "intrinsic", "name": "undefined" } } ], "groups": [ { "title": "Properties", "children": [463, 464, 465] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 112, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L112" } ] } } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 619, "name": "default.order" } }, { "id": 466, "name": "order", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 114, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L114" } ], "parameters": [ { "id": 467, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 468, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 469, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 470, "name": "ascending", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 116, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L116" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 471, "name": "nullsFirst", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 116, "character": 37, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L116" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 472, "name": "referencedTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 116, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L116" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [470, 471, 472] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 116, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L116" } ] } } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 627, "name": "default.order" } }, { "id": 473, "name": "order", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Use " }, { "kind": "code", "text": "`options.referencedTable`" }, { "kind": "text", "text": " instead of " }, { "kind": "code", "text": "`options.foreignTable`" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 121, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L121" } ], "typeParameters": [ { "id": 474, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 475, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 474, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 476, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 477, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 478, "name": "ascending", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 123, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L123" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 480, "name": "foreignTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 123, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L123" } ], "type": { "type": "intrinsic", "name": "undefined" } }, { "id": 479, "name": "nullsFirst", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 123, "character": 37, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L123" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [478, 480, 479] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 123, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L123" } ] } } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 634, "name": "default.order" } }, { "id": 481, "name": "order", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Use " }, { "kind": "code", "text": "`options.referencedTable`" }, { "kind": "text", "text": " instead of " }, { "kind": "code", "text": "`options.foreignTable`" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 128, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L128" } ], "parameters": [ { "id": 482, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 483, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 484, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 485, "name": "ascending", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 130, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L130" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 487, "name": "foreignTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 130, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L130" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 486, "name": "nullsFirst", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 130, "character": 37, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L130" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [485, 487, 486] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 130, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L130" } ] } } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 642, "name": "default.order" } } ], "inheritedFrom": { "type": "reference", "target": 618, "name": "default.order" } }, { "id": 395, "name": "overlaps", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Only relevant for array and range columns. Match only rows where\n" }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`value`" }, { "kind": "text", "text": " have an element in common." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The array or range column to filter on" } ] }, { "tag": "@param", "name": "value", "content": [ { "kind": "text", "text": "The array or range value to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "On array columns", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('issues')\n .select('title')\n .overlaps('tags', ['is:closed', 'severity:high'])\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On array columns\n" }, { "kind": "code", "text": "```sql\ncreate table\n issues (\n id int8 primary key,\n title text,\n tags text[]\n );\n\ninsert into\n issues (id, title, tags)\nvalues\n (1, 'Cache invalidation is not working', array['is:open', 'severity:high', 'priority:low']),\n (2, 'Use better names', array['is:open', 'severity:low', 'priority:medium']);\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On array columns\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"title\": \"Cache invalidation is not working\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "On range columns\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." } ] }, { "tag": "@example", "name": "On range columns", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .overlaps('during', '[2000-01-01 12:45, 2000-01-01 13:15)')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On range columns\n" }, { "kind": "code", "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On range columns\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1428, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1428" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1432, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1432" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1524, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1524" } ], "signatures": [ { "id": 396, "name": "overlaps", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1428, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1428" } ], "typeParameters": [ { "id": 397, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 398, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 397, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 399, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "indexedAccess", "indexType": { "type": "reference", "target": 397, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "objectType": { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true } } } } ] } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 400, "name": "overlaps", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1432, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1432" } ], "parameters": [ { "id": 401, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 402, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "typeOperator", "operator": "readonly", "target": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } } } ] } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 569, "name": "overrideTypes", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 424, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L424" } ], "signatures": [ { "id": 570, "name": "overrideTypes", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Override the type of the returned " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " field in the response." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A PostgrestBuilder instance with the new type" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "Complete Override type of successful response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Complete Override type of successful response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // MyType[]\n```" } ] }, { "tag": "@example", "name": "Complete Override type of object response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Complete Override type of object response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // MyType | null\n```" } ] }, { "tag": "@example", "name": "Partial Override type of successful response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Partial Override type of successful response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // Array\n```" } ] }, { "tag": "@example", "name": "Partial Override type of object response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Partial Override type of object response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" } ] }, { "tag": "@example", "name": "Example 5", "content": [ { "kind": "code", "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 424, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L424" } ], "typeParameters": [ { "id": 571, "name": "NewResult", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The new type to cast the response data to" } ] } }, { "id": 572, "name": "Options", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Optional type configuration (defaults to { merge: true })" } ] }, "type": { "type": "reflection", "declaration": { "id": 573, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 574, "name": "merge", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 22, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [574] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 20, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ] } }, "default": { "type": "reflection", "declaration": { "id": 575, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 576, "name": "merge", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 44, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ], "type": { "type": "literal", "value": true } } ], "groups": [ { "title": "Properties", "children": [576] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 42, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ] } } } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "IsValidResultOverride" }, "typeArguments": [ { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "literal", "value": false }, { "type": "literal", "value": false } ], "name": "IsValidResultOverride", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/types.ts", "qualifiedName": "ContainsNull" }, "typeArguments": [ { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "ContainsNull", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "MergePartialResult" }, "typeArguments": [ { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "NonNullable" }, "typeArguments": [ { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "NonNullable", "package": "typescript" }, { "type": "reference", "target": 572, "name": "Options", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "MergePartialResult", "package": "@supabase/postgrest-js" } ] }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "MergePartialResult" }, "typeArguments": [ { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 572, "name": "Options", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "MergePartialResult", "package": "@supabase/postgrest-js" } }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "CheckMatchingArrayTypes" }, "typeArguments": [ { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "CheckMatchingArrayTypes", "package": "@supabase/postgrest-js" } }, { "type": "literal", "value": false } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": 731, "name": "default.overrideTypes" } } ], "inheritedFrom": { "type": "reference", "target": 730, "name": "default.overrideTypes" } }, { "id": 495, "name": "range", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 511, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L511" } ], "signatures": [ { "id": 496, "name": "range", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Limit the query result by starting at an offset " }, { "kind": "code", "text": "`from`" }, { "kind": "text", "text": " and ending at the offset " }, { "kind": "code", "text": "`to`" }, { "kind": "text", "text": ".\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe " }, { "kind": "code", "text": "`from`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`to`" }, { "kind": "text", "text": " values are 0-based and inclusive: " }, { "kind": "code", "text": "`range(1, 3)`" }, { "kind": "text", "text": " will include the second, third\nand fourth rows of the query." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 511, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L511" } ], "parameters": [ { "id": 497, "name": "from", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The starting index from which to limit the result" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 498, "name": "to", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The last index to which to limit the result" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 499, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 500, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 501, "name": "foreignTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Deprecated, use " }, { "kind": "code", "text": "`options.referencedTable`" }, { "kind": "text", "text": "\ninstead" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 517, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L517" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 502, "name": "referencedTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Set this to limit rows of referenced\ntables instead of the parent table" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 517, "character": 32, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L517" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "foreignTable" } ], "groups": [ { "title": "Properties", "children": [501, 502] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 517, "character": 7, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L517" } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 657, "name": "default.range" } } ], "inheritedFrom": { "type": "reference", "target": 656, "name": "default.range" } }, { "id": 387, "name": "rangeAdjacent", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Only relevant for range columns. Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is\nmutually exclusive to " }, { "kind": "code", "text": "`range`" }, { "kind": "text", "text": " and there can be no element between the two\nranges." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The range column to filter on" } ] }, { "tag": "@param", "name": "range", "content": [ { "kind": "text", "text": "The range to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeAdjacent('during', '[2000-01-01 12:00, 2000-01-01 13:00)')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1366, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1366" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1367, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1367" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1423, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1423" } ], "signatures": [ { "id": 388, "name": "rangeAdjacent", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1366, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1366" } ], "typeParameters": [ { "id": 389, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 390, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 389, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 391, "name": "range", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 392, "name": "rangeAdjacent", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1367, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1367" } ], "parameters": [ { "id": 393, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 394, "name": "range", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 355, "name": "rangeGt", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Only relevant for range columns. Match only rows where every element in\n" }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is greater than any element in " }, { "kind": "code", "text": "`range`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The range column to filter on" } ] }, { "tag": "@param", "name": "range", "content": [ { "kind": "text", "text": "The range to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeGt('during', '[2000-01-02 08:00, 2000-01-02 09:00)')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n {\n \"data\": [\n {\n \"id\": 2,\n \"room_name\": \"Topaz\",\n \"during\": \"[\\\"2000-01-02 09:00:00\\\",\\\"2000-01-02 10:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1117, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1117" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1118, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1118" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1174, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1174" } ], "signatures": [ { "id": 356, "name": "rangeGt", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1117, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1117" } ], "typeParameters": [ { "id": 357, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 358, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 357, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 359, "name": "range", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 360, "name": "rangeGt", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1118, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1118" } ], "parameters": [ { "id": 361, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 362, "name": "range", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 363, "name": "rangeGte", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Only relevant for range columns. Match only rows where every element in\n" }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is either contained in " }, { "kind": "code", "text": "`range`" }, { "kind": "text", "text": " or greater than any element in\n" }, { "kind": "code", "text": "`range`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The range column to filter on" } ] }, { "tag": "@param", "name": "range", "content": [ { "kind": "text", "text": "The range to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeGte('during', '[2000-01-02 08:30, 2000-01-02 09:30)')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n {\n \"data\": [\n {\n \"id\": 2,\n \"room_name\": \"Topaz\",\n \"during\": \"[\\\"2000-01-02 09:00:00\\\",\\\"2000-01-02 10:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1179, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1179" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1180, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1180" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1237, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1237" } ], "signatures": [ { "id": 364, "name": "rangeGte", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1179, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1179" } ], "typeParameters": [ { "id": 365, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 366, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 365, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 367, "name": "range", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 368, "name": "rangeGte", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1180, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1180" } ], "parameters": [ { "id": 369, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 370, "name": "range", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 371, "name": "rangeLt", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Only relevant for range columns. Match only rows where every element in\n" }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is less than any element in " }, { "kind": "code", "text": "`range`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The range column to filter on" } ] }, { "tag": "@param", "name": "range", "content": [ { "kind": "text", "text": "The range to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeLt('during', '[2000-01-01 15:00, 2000-01-01 16:00)')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1242, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1242" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1243, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1243" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1298, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1298" } ], "signatures": [ { "id": 372, "name": "rangeLt", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1242, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1242" } ], "typeParameters": [ { "id": 373, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 374, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 373, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 375, "name": "range", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 376, "name": "rangeLt", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1243, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1243" } ], "parameters": [ { "id": 377, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 378, "name": "range", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 379, "name": "rangeLte", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Only relevant for range columns. Match only rows where every element in\n" }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " is either contained in " }, { "kind": "code", "text": "`range`" }, { "kind": "text", "text": " or less than any element in\n" }, { "kind": "code", "text": "`range`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The range column to filter on" } ] }, { "tag": "@param", "name": "range", "content": [ { "kind": "text", "text": "The range to filter with" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\nPostgres supports a number of [range\ntypes](https://www.postgresql.org/docs/current/rangetypes.html). You\ncan filter on range columns using the string representation of range\nvalues." } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('reservations')\n .select()\n .rangeLte('during', '[2000-01-01 14:00, 2000-01-01 16:00)')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n reservations (\n id int8 primary key,\n room_name text,\n during tsrange\n );\n\ninsert into\n reservations (id, room_name, during)\nvalues\n (1, 'Emerald', '[2000-01-01 13:00, 2000-01-01 15:00)'),\n (2, 'Topaz', '[2000-01-02 09:00, 2000-01-02 10:00)');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n {\n \"data\": [\n {\n \"id\": 1,\n \"room_name\": \"Emerald\",\n \"during\": \"[\\\"2000-01-01 13:00:00\\\",\\\"2000-01-01 15:00:00\\\")\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1303, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1303" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1304, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1304" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1361, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1361" } ], "signatures": [ { "id": 380, "name": "rangeLte", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1303, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1303" } ], "typeParameters": [ { "id": 381, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 382, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 381, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 383, "name": "range", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 384, "name": "rangeLte", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1304, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1304" } ], "parameters": [ { "id": 385, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 386, "name": "range", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 308, "name": "regexIMatch", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " matches the PostgreSQL regex " }, { "kind": "code", "text": "`pattern`" }, { "kind": "text", "text": "\ncase-insensitively (using the " }, { "kind": "code", "text": "`~*`" }, { "kind": "text", "text": " operator)." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "pattern", "content": [ { "kind": "text", "text": "The PostgreSQL regular expression pattern to match with" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 622, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L622" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 623, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L623" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 631, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L631" } ], "signatures": [ { "id": 309, "name": "regexIMatch", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 622, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L622" } ], "typeParameters": [ { "id": 310, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 311, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 310, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 312, "name": "pattern", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 313, "name": "regexIMatch", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 623, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L623" } ], "parameters": [ { "id": 314, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 315, "name": "pattern", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 300, "name": "regexMatch", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Match only rows where " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " matches the PostgreSQL regex " }, { "kind": "code", "text": "`pattern`" }, { "kind": "text", "text": "\ncase-sensitively (using the " }, { "kind": "code", "text": "`~`" }, { "kind": "text", "text": " operator)." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to filter on" } ] }, { "tag": "@param", "name": "pattern", "content": [ { "kind": "text", "text": "The PostgreSQL regular expression pattern to match with" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 608, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L608" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 609, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L609" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 617, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L617" } ], "signatures": [ { "id": 301, "name": "regexMatch", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 608, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L608" } ], "typeParameters": [ { "id": 302, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 303, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 302, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 304, "name": "pattern", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 305, "name": "regexMatch", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 609, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L609" } ], "parameters": [ { "id": 306, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 307, "name": "pattern", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 528, "name": "returns", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 929, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L929" } ], "signatures": [ { "id": 529, "name": "returns", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Override the type of the returned " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Use overrideTypes() method at the end of your call chain instead" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Deprecated: use overrideTypes method instead" } ] }, { "tag": "@example", "name": "Override type of successful response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Override type of successful response\n" }, { "kind": "code", "text": "```js\nlet x: typeof data // MyType[]\n```" } ] }, { "tag": "@example", "name": "Override type of object response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Override type of object response\n" }, { "kind": "code", "text": "```js\nlet x: typeof data // MyType | null\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 929, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L929" } ], "typeParameters": [ { "id": 530, "name": "NewResult", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The new result type to override with" } ] } } ], "type": { "type": "reference", "target": 584, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "CheckMatchingArrayTypes" }, "typeArguments": [ { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 530, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "CheckMatchingArrayTypes", "package": "@supabase/postgrest-js" }, { "type": "reference", "target": 187, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 188, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 189, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true } ], "name": "PostgrestTransformBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": 690, "name": "default.returns" } } ], "inheritedFrom": { "type": "reference", "target": 689, "name": "default.returns" } }, { "id": 526, "name": "rollback", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 886, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L886" } ], "signatures": [ { "id": 527, "name": "rollback", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Rollback the query.\n\n" }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " will still be returned, but the query is not committed." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 886, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L886" } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 688, "name": "default.rollback" } } ], "inheritedFrom": { "type": "reference", "target": 687, "name": "default.rollback" } }, { "id": 452, "name": "select", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 61, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L61" } ], "signatures": [ { "id": 453, "name": "select", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Perform a SELECT on the query result.\n\nBy default, " }, { "kind": "code", "text": "`.insert()`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`.update()`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`.upsert()`" }, { "kind": "text", "text": ", and " }, { "kind": "code", "text": "`.delete()`" }, { "kind": "text", "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `upsert()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`upsert()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`upsert()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 61, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L61" } ], "typeParameters": [ { "id": 454, "name": "Query", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "literal", "value": "*" } }, { "id": 455, "name": "NewResultOne", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 853, "typeArguments": [ { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 187, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 188, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 454, "name": "Query", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true } ], "name": "GetResult", "package": "@supabase/postgrest-js" } } ], "parameters": [ { "id": 456, "name": "columns", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The columns to retrieve, separated by commas" } ] }, "type": { "type": "reference", "target": 454, "name": "Query", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "conditional", "checkType": { "type": "reference", "target": 189, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true }, "extendsType": { "type": "literal", "value": "RPC" }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, "extendsType": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } }, "trueType": { "type": "array", "elementType": { "type": "reference", "target": 455, "name": "NewResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "falseType": { "type": "reference", "target": 455, "name": "NewResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "falseType": { "type": "array", "elementType": { "type": "reference", "target": 455, "name": "NewResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } }, { "type": "reference", "target": 187, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 188, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 189, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": 614, "name": "default.select" } } ], "inheritedFrom": { "type": "reference", "target": 613, "name": "default.select" } }, { "id": 553, "name": "setHeader", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 104, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L104" } ], "signatures": [ { "id": 554, "name": "setHeader", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Set an HTTP header for the request." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 104, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L104" } ], "parameters": [ { "id": 555, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 556, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 715, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", "target": 714, "name": "default.setHeader" } }, { "id": 506, "name": "single", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 639, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L639" } ], "signatures": [ { "id": 507, "name": "single", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Return " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " }, { "kind": "code", "text": "`.limit(1)`" }, { "kind": "text", "text": "), otherwise this\nreturns an error." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 639, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L639" } ], "typeParameters": [ { "id": 508, "name": "ResultOne", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, "extendsType": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 508, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": 668, "name": "default.single" } } ], "inheritedFrom": { "type": "reference", "target": 667, "name": "default.single" } }, { "id": 403, "name": "textSearch", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Only relevant for text and tsvector columns. Match only rows where\n" }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": " matches the query string in " }, { "kind": "code", "text": "`query`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The text or tsvector column to filter on" } ] }, { "tag": "@param", "name": "query", "content": [ { "kind": "text", "text": "The query text to match with" } ] }, { "tag": "@param", "name": "options", "content": [ { "kind": "text", "text": "Named parameters" } ] }, { "tag": "@param", "name": "options.config", "content": [ { "kind": "text", "text": "The text search configuration to use" } ] }, { "tag": "@param", "name": "options.type", "content": [ { "kind": "text", "text": "Change how the " }, { "kind": "code", "text": "`query`" }, { "kind": "text", "text": " text is interpreted" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- For more information, see [Postgres full text search](/docs/guides/database/full-text-search)." } ] }, { "tag": "@example", "name": "Text search", "content": [ { "kind": "code", "text": "```ts\nconst result = await supabase\n .from(\"texts\")\n .select(\"content\")\n .textSearch(\"content\", `'eggs' & 'ham'`, {\n config: \"english\",\n });\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Text search\n" }, { "kind": "code", "text": "```sql\ncreate table texts (\n id bigint\n primary key\n generated always as identity,\n content text\n);\n\ninsert into texts (content) values\n ('Four score and seven years ago'),\n ('The road goes ever on and on'),\n ('Green eggs and ham')\n;\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Text search\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"content\": \"Green eggs and ham\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Basic normalization\nUses PostgreSQL's " }, { "kind": "code", "text": "`plainto_tsquery`" }, { "kind": "text", "text": " function." } ] }, { "tag": "@example", "name": "Basic normalization", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat' & 'cat'`, {\n type: 'plain',\n config: 'english'\n })\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Full normalization\nUses PostgreSQL's " }, { "kind": "code", "text": "`phraseto_tsquery`" }, { "kind": "text", "text": " function." } ] }, { "tag": "@example", "name": "Full normalization", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat' & 'cat'`, {\n type: 'phrase',\n config: 'english'\n })\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Websearch\nUses PostgreSQL's " }, { "kind": "code", "text": "`websearch_to_tsquery`" }, { "kind": "text", "text": " function.\nThis function will never raise syntax errors, which makes it possible to use raw user-supplied input for search, and can be used\nwith advanced operators.\n\n- " }, { "kind": "code", "text": "`unquoted text`" }, { "kind": "text", "text": ": text not inside quote marks will be converted to terms separated by & operators, as if processed by plainto_tsquery.\n- " }, { "kind": "code", "text": "`\"quoted text\"`" }, { "kind": "text", "text": ": text inside quote marks will be converted to terms separated by " }, { "kind": "code", "text": "`<->`" }, { "kind": "text", "text": " operators, as if processed by phraseto_tsquery.\n- " }, { "kind": "code", "text": "`OR`" }, { "kind": "text", "text": ": the word “or” will be converted to the | operator.\n- " }, { "kind": "code", "text": "`-`" }, { "kind": "text", "text": ": a dash will be converted to the ! operator." } ] }, { "tag": "@example", "name": "Websearch", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('quotes')\n .select('catchphrase')\n .textSearch('catchphrase', `'fat or cat'`, {\n type: 'websearch',\n config: 'english'\n })\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1535, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1535" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1540, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1540" }, { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1648, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1648" } ], "signatures": [ { "id": 404, "name": "textSearch", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1535, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1535" } ], "typeParameters": [ { "id": 405, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 406, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 405, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 407, "name": "query", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 408, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 409, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 410, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1538, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1538" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 411, "name": "type", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1538, "character": 33, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1538" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "plain" }, { "type": "literal", "value": "phrase" }, { "type": "literal", "value": "websearch" } ] } } ], "groups": [ { "title": "Properties", "children": [410, 411] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1538, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1538" } ] } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 412, "name": "textSearch", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1540, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1540" } ], "parameters": [ { "id": 413, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 414, "name": "query", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 415, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 416, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 417, "name": "config", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1543, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1543" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 418, "name": "type", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1543, "character": 33, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1543" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "plain" }, { "type": "literal", "value": "phrase" }, { "type": "literal", "value": "websearch" } ] } } ], "groups": [ { "title": "Properties", "children": [417, 418] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 1543, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1543" } ] } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 557, "name": "then", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 113, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" } ], "signatures": [ { "id": 558, "name": "then", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 113, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" } ], "typeParameters": [ { "id": 559, "name": "TResult1", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 846, "typeArguments": [ { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "PostgrestSingleResponse", "package": "@supabase/postgrest-js" } }, { "id": 560, "name": "TResult2", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 561, "name": "onfulfilled", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 562, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 120, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" } ], "signatures": [ { "id": 563, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 120, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" } ], "parameters": [ { "id": 564, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 846, "typeArguments": [ { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "PostgrestSingleResponse", "package": "@supabase/postgrest-js" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 559, "name": "TResult1", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 559, "name": "TResult1", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "PromiseLike", "package": "typescript" } ] } } ] } } ] } }, { "id": 565, "name": "onrejected", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 566, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 127, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L127" } ], "signatures": [ { "id": 567, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 127, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L127" } ], "parameters": [ { "id": 568, "name": "reason", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 560, "name": "TResult2", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 560, "name": "TResult2", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "PromiseLike", "package": "typescript" } ] } } ] } } ] } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": 559, "name": "TResult1", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 560, "name": "TResult2", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ] } ], "name": "PromiseLike", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 719, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", "target": 718, "name": "default.then" } }, { "id": 551, "name": "throwOnError", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 94, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L94" } ], "signatures": [ { "id": 552, "name": "throwOnError", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" }, { "kind": "inline-tag", "tag": "@link", "text": "https://github.com/supabase/supabase-js/issues/92", "target": "https://github.com/supabase/supabase-js/issues/92" } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 94, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L94" } ], "type": { "type": "intersection", "types": [ { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 187, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 188, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 189, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "literal", "value": true } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } ] }, "inheritedFrom": { "type": "reference", "target": 713, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", "target": 712, "name": "default.throwOnError" } } ], "groups": [ { "title": "Constructors", "children": [181] }, { "title": "Properties", "children": [538, 541, 536, 549, 534, 537, 539, 540, 535, 550] }, { "title": "Methods", "children": [ 503, 347, 339, 512, 209, 516, 442, 514, 220, 228, 276, 284, 292, 329, 316, 324, 252, 260, 268, 488, 236, 244, 419, 531, 509, 215, 425, 334, 435, 457, 395, 569, 495, 387, 355, 363, 371, 379, 308, 300, 528, 526, 452, 553, 506, 403, 557, 551 ] } ], "categories": [ { "title": "Database", "children": [ 181, 503, 347, 339, 512, 209, 516, 442, 514, 220, 228, 276, 284, 292, 329, 316, 252, 260, 268, 488, 236, 244, 419, 531, 509, 215, 425, 435, 457, 395, 569, 495, 387, 355, 363, 371, 379, 528, 526, 452, 553, 506, 403, 557, 551 ] }, { "title": "Other", "children": [538, 541, 536, 549, 534, 537, 539, 540, 535, 550, 324, 334, 308, 300] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts", "line": 79, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L79" } ], "typeParameters": [ { "id": 577, "name": "ClientOptions", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" } }, { "id": 578, "name": "Schema", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" } }, { "id": 579, "name": "Row", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } }, { "id": 580, "name": "Result", "variant": "typeParam", "kind": 131072, "flags": {} }, { "id": 581, "name": "RelationName", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 582, "name": "Relationships", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 583, "name": "Method", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "extendedTypes": [ { "type": "reference", "target": 584, "typeArguments": [ { "type": "reference", "target": 183, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 184, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 185, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 186, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 187, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 188, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 189, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true } ], "name": "default", "package": "@supabase/postgrest-js" } ] }, { "id": 78, "name": "PostgrestQueryBuilder", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { "id": 79, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 40, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L40" } ], "signatures": [ { "id": 80, "name": "PostgrestQueryBuilder", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a query builder scoped to a Postgres table or view." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "Creating a Postgrest query builder", "content": [ { "kind": "code", "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst query = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: { apikey: 'public-anon-key' } }\n)\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 40, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L40" } ], "typeParameters": [ { "id": 81, "name": "ClientOptions", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" } }, { "id": 82, "name": "Schema", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" } }, { "id": 83, "name": "Relation", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericTable" }, "name": "GenericTable", "package": "@supabase/postgrest-js" }, { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericView" }, "name": "GenericView", "package": "@supabase/postgrest-js" } ] } }, { "id": 84, "name": "RelationName", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 85, "name": "Relationships", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "target": 83, "name": "Relation", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relation", "refersToTypeParameter": true }, "extendsType": { "type": "reflection", "declaration": { "id": 86, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 87, "name": "Relationships", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 16, "character": 37, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L16" } ], "type": { "type": "reference", "target": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "R" }, "name": "R", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } ], "groups": [ { "title": "Properties", "children": [87] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 16, "character": 35, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L16" } ] } }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "R" }, "name": "R", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "intrinsic", "name": "unknown" } } } ], "parameters": [ { "id": 88, "name": "url", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } }, { "id": 89, "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 90, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 93, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 50, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L50" } ], "type": { "type": "reflection", "declaration": { "id": 94, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 95, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 96, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" } ] } }, { "id": 97, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 98, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 99, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" } ] } }, { "id": 100, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 91, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 48, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L48" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "HeadersInit" }, "name": "HeadersInit", "package": "typescript" }, "defaultValue": "{}" }, { "id": 92, "name": "schema", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 49, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L49" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 101, "name": "urlLengthLimit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 51, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L51" } ], "type": { "type": "intrinsic", "name": "number" }, "defaultValue": "8000" } ], "groups": [ { "title": "Properties", "children": [93, 91, 92, 101] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 47, "character": 7, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L47" } ] } } } ], "type": { "type": "reference", "target": 78, "typeArguments": [ { "type": "reference", "target": 81, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 82, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 83, "name": "Relation", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relation", "refersToTypeParameter": true }, { "type": "reference", "target": 84, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 85, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true } ], "name": "PostgrestQueryBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 106, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 22, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L22" } ], "type": { "type": "reflection", "declaration": { "id": 107, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 108, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 109, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" } ] } }, { "id": 110, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 111, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 112, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" } ] } }, { "id": 113, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 103, "name": "headers", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 19, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L19" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" } }, { "id": 104, "name": "schema", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 20, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L20" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 105, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L21" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" } }, { "id": 102, "name": "url", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 18, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L18" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } }, { "id": 114, "name": "urlLengthLimit", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 23, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L23" } ], "type": { "type": "intrinsic", "name": "number" } }, { "id": 168, "name": "delete", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1686, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1686" } ], "signatures": [ { "id": 169, "name": "delete", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Perform a DELETE on the table or view.\n\nBy default, deleted rows are not returned. To return it, chain the call\nwith " }, { "kind": "code", "text": "`.select()`" }, { "kind": "text", "text": " after filters." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- " }, { "kind": "code", "text": "`delete()`" }, { "kind": "text", "text": " should always be combined with [filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to delete.\n- If you use " }, { "kind": "code", "text": "`delete()`" }, { "kind": "text", "text": " with filters and you have\n [RLS](/docs/learn/auth-deep-dive/auth-row-level-security) enabled, only\n rows visible through " }, { "kind": "code", "text": "`SELECT`" }, { "kind": "text", "text": " policies are deleted. Note that by default\n no rows are visible, so you need at least one " }, { "kind": "code", "text": "`SELECT`" }, { "kind": "text", "text": "/" }, { "kind": "code", "text": "`ALL`" }, { "kind": "text", "text": " policy that\n makes the rows visible.\n- When using " }, { "kind": "code", "text": "`delete().in()`" }, { "kind": "text", "text": ", 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." } ] }, { "tag": "@example", "name": "Delete a single record", "content": [ { "kind": "code", "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Delete a single record\n" }, { "kind": "code", "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Delete a single record\n" }, { "kind": "code", "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" } ] }, { "tag": "@example", "name": "Delete a record and return it", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .delete()\n .eq('id', 1)\n .select()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Delete a record and return it\n" }, { "kind": "code", "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Mordor');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Delete a record and return it\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@example", "name": "Delete multiple records", "content": [ { "kind": "code", "text": "```ts\nconst response = await supabase\n .from('countries')\n .delete()\n .in('id', [1, 2, 3])\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Delete multiple records\n" }, { "kind": "code", "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n\ninsert into\n countries (id, name)\nvalues\n (1, 'Rohan'), (2, 'The Shire'), (3, 'Mordor');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Delete multiple records\n" }, { "kind": "code", "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1686, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1686" } ], "parameters": [ { "id": 170, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 171, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 172, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Count algorithm to use to count deleted rows.\n\n" }, { "kind": "code", "text": "`\"exact\"`" }, { "kind": "text", "text": ": Exact but slow count algorithm. Performs a " }, { "kind": "code", "text": "`COUNT(*)`" }, { "kind": "text", "text": " under the\nhood.\n\n" }, { "kind": "code", "text": "`\"planned\"`" }, { "kind": "text", "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" }, { "kind": "code", "text": "`\"estimated\"`" }, { "kind": "text", "text": ": Uses exact count for low numbers and planned count for high\nnumbers." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1689, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1689" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } } ], "groups": [ { "title": "Properties", "children": [172] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1688, "character": 5, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1688" } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 81, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 82, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "target": 83, "name": "Relation", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relation", "refersToTypeParameter": true } }, { "type": "literal", "value": null }, { "type": "reference", "target": 84, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 85, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "literal", "value": "DELETE" } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 129, "name": "insert", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Perform an INSERT into the table or view.\n\nBy default, inserted rows are not returned. To return it, chain the call\nwith " }, { "kind": "code", "text": "`.select()`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "values", "content": [ { "kind": "text", "text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows." } ] }, { "tag": "@param", "name": "options", "content": [ { "kind": "text", "text": "Named parameters" } ] }, { "tag": "@param", "name": "options.count", "content": [ { "kind": "text", "text": "Count algorithm to use to count inserted rows.\n\n" }, { "kind": "code", "text": "`\"exact\"`" }, { "kind": "text", "text": ": Exact but slow count algorithm. Performs a " }, { "kind": "code", "text": "`COUNT(*)`" }, { "kind": "text", "text": " under the\nhood.\n\n" }, { "kind": "code", "text": "`\"planned\"`" }, { "kind": "text", "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" }, { "kind": "code", "text": "`\"estimated\"`" }, { "kind": "text", "text": ": Uses exact count for low numbers and planned count for high\nnumbers." } ] }, { "tag": "@param", "name": "options.defaultToNull", "content": [ { "kind": "text", "text": "Make missing fields default to " }, { "kind": "code", "text": "`null`" }, { "kind": "text", "text": ".\nOtherwise, use the default value for the column. Only applies for bulk\ninserts." } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "Create a record", "content": [ { "kind": "code", "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Create a record\n" }, { "kind": "code", "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Create a record\n" }, { "kind": "code", "text": "```json\n{\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" } ] }, { "tag": "@example", "name": "Create a record and return it", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('countries')\n .insert({ id: 1, name: 'Mordor' })\n .select()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Create a record and return it\n" }, { "kind": "code", "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Create a record and return it\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Mordor\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Bulk create\nA bulk create operation is handled in a single transaction.\nIf any of the inserts fail, none of the rows are inserted." } ] }, { "tag": "@example", "name": "Bulk create", "content": [ { "kind": "code", "text": "```ts\nconst { error } = await supabase\n .from('countries')\n .insert([\n { id: 1, name: 'Mordor' },\n { id: 1, name: 'The Shire' },\n ])\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Bulk create\n" }, { "kind": "code", "text": "```sql\ncreate table\n countries (id int8 primary key, name text);\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Bulk create\n" }, { "kind": "code", "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (id)=(1) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"countries_pkey\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 911, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L911" }, { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 925, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L925" }, { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1051, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1051" } ], "signatures": [ { "id": 130, "name": "insert", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 911, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L911" } ], "typeParameters": [ { "id": 131, "name": "Row", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 132, "name": "values", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 131, "name": "Row", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 133, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 134, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 135, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 914, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L914" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } } ], "groups": [ { "title": "Properties", "children": [135] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 913, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L913" } ] } } } ], "type": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 81, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 82, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "target": 83, "name": "Relation", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relation", "refersToTypeParameter": true } }, { "type": "literal", "value": null }, { "type": "reference", "target": 84, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 85, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "literal", "value": "POST" } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } }, { "id": 136, "name": "insert", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 925, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L925" } ], "typeParameters": [ { "id": 137, "name": "Row", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 138, "name": "values", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": 137, "name": "Row", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } }, { "id": 139, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 140, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 141, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 928, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L928" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 142, "name": "defaultToNull", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 929, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L929" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [141, 142] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 927, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L927" } ] } } } ], "type": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 81, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 82, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "target": 83, "name": "Relation", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relation", "refersToTypeParameter": true } }, { "type": "literal", "value": null }, { "type": "reference", "target": 84, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 85, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "literal", "value": "POST" } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 120, "name": "select", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 850, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L850" } ], "signatures": [ { "id": 121, "name": "select", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Perform a SELECT query on the table or view." } ], "blockTags": [ { "tag": "@remarks", "content": [ { "kind": "text", "text": "When using " }, { "kind": "code", "text": "`count`" }, { "kind": "text", "text": " with " }, { "kind": "code", "text": "`.range()`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`.limit()`" }, { "kind": "text", "text": ", the returned " }, { "kind": "code", "text": "`count`" }, { "kind": "text", "text": " is the total number of rows\nthat match your filters, not the number of rows in the current page. Use this to build pagination UI.\n\n- 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 " }, { "kind": "code", "text": "`range()`" }, { "kind": "text", "text": " queries to paginate through your data.\n- " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": " can be combined with [Filters](/docs/reference/javascript/using-filters)\n- " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": " can be combined with [Modifiers](/docs/reference/javascript/using-modifiers)\n- " }, { "kind": "code", "text": "`apikey`" }, { "kind": "text", "text": " 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). *" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "Getting your data", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Getting your data\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Harry'),\n (2, 'Frodo'),\n (3, 'Katniss');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Getting your data\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Harry\"\n },\n {\n \"id\": 2,\n \"name\": \"Frodo\"\n },\n {\n \"id\": 3,\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@example", "name": "Selecting specific columns", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Selecting specific columns\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Frodo'),\n (2, 'Harry'),\n (3, 'Katniss');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Selecting specific columns\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Frodo\"\n },\n {\n \"name\": \"Harry\"\n },\n {\n \"name\": \"Katniss\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Query referenced tables\nIf your database has foreign key relationships, you can query related tables too." } ] }, { "tag": "@example", "name": "Query referenced tables", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Query referenced tables\n" }, { "kind": "code", "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Query referenced tables\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Query referenced tables with spaces in their names\nIf your table name contains spaces, you must use double quotes in the " }, { "kind": "code", "text": "`select`" }, { "kind": "text", "text": " statement to reference the table." } ] }, { "tag": "@example", "name": "Query referenced tables with spaces in their names", "content": [ { "kind": "code", "text": "```js\nconst { data, error } = await supabase\n .from('orchestral sections')\n .select(`\n name,\n \"musical instruments\" (\n name\n )\n `)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Query referenced tables with spaces in their names\n" }, { "kind": "code", "text": "```sql\ncreate table\n \"orchestral sections\" (id int8 primary key, name text);\ncreate table\n \"musical instruments\" (\n id int8 primary key,\n section_id int8 not null references \"orchestral sections\",\n name text\n );\n\ninsert into\n \"orchestral sections\" (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n \"musical instruments\" (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Query referenced tables with spaces in their names\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"musical instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"musical instruments\": [\n {\n \"name\": \"flute\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Query referenced tables through a join table\nIf you're in a situation where your tables are **NOT** directly\nrelated, but instead are joined by a _join table_, you can still use\nthe " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": " method to query the related data. The join table needs\nto have the foreign keys as part of its composite primary key." } ] }, { "tag": "@example", "name": "Query referenced tables through a join table", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n name,\n teams (\n name\n )\n `)\n \n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Query referenced tables through a join table\n" }, { "kind": "code", "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n -- both foreign keys must be part of a composite primary key\n primary key (user_id, team_id)\n );\n\ninsert into\n users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Query referenced tables through a join table\n" }, { "kind": "code", "text": "```json\n {\n \"data\": [\n {\n \"name\": \"Kiran\",\n \"teams\": [\n {\n \"name\": \"Green\"\n },\n {\n \"name\": \"Blue\"\n }\n ]\n },\n {\n \"name\": \"Evan\",\n \"teams\": [\n {\n \"name\": \"Blue\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n \n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Query the same referenced table multiple times\nIf you need to query the same referenced table twice, use the name of the\njoined column to identify which join to use. You can also give each\ncolumn an alias." } ] }, { "tag": "@example", "name": "Query the same referenced table multiple times", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:sender_id(name),\n to:receiver_id(name)\n `)\n\n// To infer types, use the name of the table (in this case `users`) and\n// the name of the foreign key constraint.\nconst { data, error } = await supabase\n .from('messages')\n .select(`\n content,\n from:users!messages_sender_id_fkey(name),\n to:users!messages_receiver_id_fkey(name)\n `)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Query the same referenced table multiple times\n" }, { "kind": "code", "text": "```sql\n create table\n users (id int8 primary key, name text);\n\n create table\n messages (\n sender_id int8 not null references users,\n receiver_id int8 not null references users,\n content text\n );\n\n insert into\n users (id, name)\n values\n (1, 'Kiran'),\n (2, 'Evan');\n\n insert into\n messages (sender_id, receiver_id, content)\n values\n (1, 2, '👋');\n ```" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```\n\n@exampleResponse Query the same referenced table multiple times\n```" }, { "kind": "text", "text": "json\n{\n \"data\": [\n {\n \"content\": \"👋\",\n \"from\": {\n \"name\": \"Kiran\"\n },\n \"to\": {\n \"name\": \"Evan\"\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n" }, { "kind": "code", "text": "```\n\n@exampleDescription Query nested foreign tables through a join table\nYou can use the result of a joined table to gather data in\nanother foreign table. With multiple references to the same foreign\ntable you must specify the column on which to conduct the join.\n\n@example Query nested foreign tables through a join table\n```" }, { "kind": "text", "text": "ts\n const { data, error } = await supabase\n .from('games')\n .select(" }, { "kind": "code", "text": "`\n game_id:id,\n away_team:teams!games_away_team_fkey (\n users (\n id,\n name\n )\n )\n `" }, { "kind": "text", "text": ")\n \n" }, { "kind": "code", "text": "```\n\n@exampleSql Query nested foreign tables through a join table\n```" }, { "kind": "text", "text": "sql\n" }, { "kind": "code", "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text\n );\ncreate table\n teams (\n id int8 primary key,\n name text\n );\n-- join table\ncreate table\n users_teams (\n user_id int8 not null references users,\n team_id int8 not null references teams,\n\n primary key (user_id, team_id)\n );\ncreate table\n games (\n id int8 primary key,\n home_team int8 not null references teams,\n away_team int8 not null references teams,\n name text\n );\n\ninsert into users (id, name)\nvalues\n (1, 'Kiran'),\n (2, 'Evan');\ninsert into\n teams (id, name)\nvalues\n (1, 'Green'),\n (2, 'Blue');\ninsert into\n users_teams (user_id, team_id)\nvalues\n (1, 1),\n (1, 2),\n (2, 2);\ninsert into\n games (id, home_team, away_team, name)\nvalues\n (1, 1, 2, 'Green vs Blue'),\n (2, 2, 1, 'Blue vs Green');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Query nested foreign tables through a join table\n" }, { "kind": "code", "text": "```json\n {\n \"data\": [\n {\n \"game_id\": 1,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n },\n {\n \"id\": 2,\n \"name\": \"Evan\"\n }\n ]\n }\n },\n {\n \"game_id\": 2,\n \"away_team\": {\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"Kiran\"\n }\n ]\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n }\n \n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Filtering through referenced tables\nIf the filter on a referenced table's column is not satisfied, the referenced\ntable returns " }, { "kind": "code", "text": "`[]`" }, { "kind": "text", "text": " or " }, { "kind": "code", "text": "`null`" }, { "kind": "text", "text": " but the parent table is not filtered out.\nIf you want to filter out the parent table rows, use the " }, { "kind": "code", "text": "`!inner`" }, { "kind": "text", "text": " hint" } ] }, { "tag": "@example", "name": "Filtering through referenced tables", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections(*)')\n .eq('orchestral_sections.name', 'percussion')\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Filtering through referenced tables\n" }, { "kind": "code", "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Filtering through referenced tables\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": null\n },\n {\n \"name\": \"violin\",\n \"orchestral_sections\": null\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Querying referenced table with count\nYou can get the number of rows in a related table by using the\n**count** property." } ] }, { "tag": "@example", "name": "Querying referenced table with count", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`*, instruments(count)`)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Querying referenced table with count\n" }, { "kind": "code", "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table characters (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('strings') returning id\n)\ninsert into instruments (name, section_id) values\n('violin', (select id from section)),\n('viola', (select id from section)),\n('cello', (select id from section)),\n('double bass', (select id from section));\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Querying referenced table with count\n" }, { "kind": "code", "text": "```json\n[\n {\n \"id\": \"693694e7-d993-4360-a6d7-6294e325d9b6\",\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"count\": 4\n }\n ]\n }\n]\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Querying with count option\nYou can get the number of rows by using the\n[count](/docs/reference/javascript/select#parameters) option." } ] }, { "tag": "@example", "name": "Querying with count option", "content": [ { "kind": "code", "text": "```ts\nconst { count, error } = await supabase\n .from('characters')\n .select('*', { count: 'exact', head: true })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Querying with count option\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Querying with count option\n" }, { "kind": "code", "text": "```json\n{\n \"count\": 3,\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Querying JSON data\nYou can select and filter data inside of\n[JSON](/docs/guides/database/json) columns. Postgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nquerying JSON data." } ] }, { "tag": "@example", "name": "Querying JSON data", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .select(`\n id, name,\n address->city\n `)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Querying JSON data\n" }, { "kind": "code", "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Frodo', '{\"city\":\"Hobbiton\"}');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Querying JSON data\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Frodo\",\n \"city\": \"Hobbiton\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Querying referenced table with inner join\nIf you don't want to return the referenced table contents, you can leave the parenthesis empty.\nLike " }, { "kind": "code", "text": "`.select('name, orchestral_sections!inner()')`" }, { "kind": "text", "text": "." } ] }, { "tag": "@example", "name": "Querying referenced table with inner join", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .select('name, orchestral_sections!inner(name)')\n .eq('orchestral_sections.name', 'woodwinds')\n .limit(1)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Querying referenced table with inner join\n" }, { "kind": "code", "text": "```sql\ncreate table orchestral_sections (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text\n);\n\ncreate table instruments (\n \"id\" \"uuid\" primary key default \"extensions\".\"uuid_generate_v4\"() not null,\n \"name\" text,\n \"section_id\" \"uuid\" references public.orchestral_sections on delete cascade\n);\n\nwith section as (\n insert into orchestral_sections (name)\n values ('woodwinds') returning id\n)\ninsert into instruments (name, section_id) values\n('flute', (select id from section)),\n('clarinet', (select id from section)),\n('bassoon', (select id from section)),\n('piccolo', (select id from section));\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Querying referenced table with inner join\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Switching schemas per query\nIn addition to setting the schema during initialization, you can also switch schemas on a per-query basis.\nMake sure you've set up your [database privileges and API settings](/docs/guides/api/using-custom-schemas)." } ] }, { "tag": "@example", "name": "Switching schemas per query", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .schema('myschema')\n .from('mytable')\n .select()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Switching schemas per query\n" }, { "kind": "code", "text": "```sql\ncreate schema myschema;\n\ncreate table myschema.mytable (\n id uuid primary key default gen_random_uuid(),\n data text\n);\n\ninsert into myschema.mytable (data) values ('mydata');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Switching schemas per query\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": \"4162e008-27b0-4c0f-82dc-ccaeee9a624d\",\n \"data\": \"mydata\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 850, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L850" } ], "typeParameters": [ { "id": 122, "name": "Query", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "literal", "value": "*" } }, { "id": 123, "name": "ResultOne", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 853, "typeArguments": [ { "type": "reference", "target": 82, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "target": 83, "name": "Relation", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relation", "refersToTypeParameter": true } }, { "type": "reference", "target": 84, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 85, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 122, "name": "Query", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 81, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true } ], "name": "GetResult", "package": "@supabase/postgrest-js" } } ], "parameters": [ { "id": 124, "name": "columns", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The columns to retrieve, separated by commas. Columns can be renamed when returned with " }, { "kind": "code", "text": "`customName:columnName`" } ] }, "type": { "type": "reference", "target": 122, "name": "Query", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 125, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 126, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 128, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Count algorithm to use to count rows in the table or view.\n\n" }, { "kind": "code", "text": "`\"exact\"`" }, { "kind": "text", "text": ": Exact but slow count algorithm. Performs a " }, { "kind": "code", "text": "`COUNT(*)`" }, { "kind": "text", "text": " under the\nhood.\n\n" }, { "kind": "code", "text": "`\"planned\"`" }, { "kind": "text", "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" }, { "kind": "code", "text": "`\"estimated\"`" }, { "kind": "text", "text": ": Uses exact count for low numbers and planned count for high\nnumbers." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 864, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L864" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 127, "name": "head", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "When set to " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " will not be returned.\nUseful if you only need the count." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 863, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L863" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [128, 127] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 862, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L862" } ] } } } ], "type": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 81, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 82, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "target": 83, "name": "Relation", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relation", "refersToTypeParameter": true } }, { "type": "array", "elementType": { "type": "reference", "target": 123, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "type": "reference", "target": 84, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 85, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "literal", "value": "GET" } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 161, "name": "update", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1534, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1534" } ], "signatures": [ { "id": 162, "name": "update", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Perform an UPDATE on the table or view.\n\nBy default, updated rows are not returned. To return it, chain the call\nwith " }, { "kind": "code", "text": "`.select()`" }, { "kind": "text", "text": " after filters." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- " }, { "kind": "code", "text": "`update()`" }, { "kind": "text", "text": " should always be combined with [Filters](/docs/reference/javascript/using-filters) to target the item(s) you wish to update." } ] }, { "tag": "@example", "name": "Updating your data", "content": [ { "kind": "code", "text": "```ts\nconst { error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Updating your data\n" }, { "kind": "code", "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Updating your data\n" }, { "kind": "code", "text": "```json\n{\n \"status\": 204,\n \"statusText\": \"No Content\"\n}\n```" } ] }, { "tag": "@example", "name": "Update a record and return it", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .update({ name: 'piano' })\n .eq('id', 1)\n .select()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Update a record and return it\n" }, { "kind": "code", "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Update a record and return it\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Updating JSON data\nPostgres offers some\n[operators](/docs/guides/database/json#query-the-jsonb-data) for\nworking with JSON data. Currently, it is only possible to update the entire JSON document." } ] }, { "tag": "@example", "name": "Updating JSON data", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .update({\n address: {\n street: 'Melrose Place',\n postcode: 90210\n }\n })\n .eq('address->postcode', 90210)\n .select()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Updating JSON data\n" }, { "kind": "code", "text": "```sql\ncreate table\n users (\n id int8 primary key,\n name text,\n address jsonb\n );\n\ninsert into\n users (id, name, address)\nvalues\n (1, 'Michael', '{ \"postcode\": 90210 }');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Updating JSON data\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Michael\",\n \"address\": {\n \"street\": \"Melrose Place\",\n \"postcode\": 90210\n }\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1534, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1534" } ], "typeParameters": [ { "id": 163, "name": "Row", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 164, "name": "values", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The values to update with" } ] }, "type": { "type": "reference", "target": 163, "name": "Row", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 165, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 166, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 167, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Count algorithm to use to count updated rows.\n\n" }, { "kind": "code", "text": "`\"exact\"`" }, { "kind": "text", "text": ": Exact but slow count algorithm. Performs a " }, { "kind": "code", "text": "`COUNT(*)`" }, { "kind": "text", "text": " under the\nhood.\n\n" }, { "kind": "code", "text": "`\"planned\"`" }, { "kind": "text", "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" }, { "kind": "code", "text": "`\"estimated\"`" }, { "kind": "text", "text": ": Uses exact count for low numbers and planned count for high\nnumbers." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1539, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1539" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } } ], "groups": [ { "title": "Properties", "children": [167] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1538, "character": 7, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1538" } ] } }, "defaultValue": "{}" } ], "type": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 81, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 82, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "target": 83, "name": "Relation", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relation", "refersToTypeParameter": true } }, { "type": "literal", "value": null }, { "type": "reference", "target": 84, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 85, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "literal", "value": "PATCH" } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 143, "name": "upsert", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Perform an UPSERT on the table or view. Depending on the column(s) passed\nto " }, { "kind": "code", "text": "`onConflict`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`.upsert()`" }, { "kind": "text", "text": " allows you to perform the equivalent of\n" }, { "kind": "code", "text": "`.insert()`" }, { "kind": "text", "text": " if a row with the corresponding " }, { "kind": "code", "text": "`onConflict`" }, { "kind": "text", "text": " columns doesn't\nexist, or if it does exist, perform an alternative action depending on\n" }, { "kind": "code", "text": "`ignoreDuplicates`" }, { "kind": "text", "text": ".\n\nBy default, upserted rows are not returned. To return it, chain the call\nwith " }, { "kind": "code", "text": "`.select()`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@param", "name": "values", "content": [ { "kind": "text", "text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows." } ] }, { "tag": "@param", "name": "options", "content": [ { "kind": "text", "text": "Named parameters" } ] }, { "tag": "@param", "name": "options.onConflict", "content": [ { "kind": "text", "text": "Comma-separated UNIQUE column(s) to specify how\nduplicate rows are determined. Two rows are duplicates if all the\n" }, { "kind": "code", "text": "`onConflict`" }, { "kind": "text", "text": " columns are equal." } ] }, { "tag": "@param", "name": "options.ignoreDuplicates", "content": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", duplicate rows are ignored. If\n" }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ", duplicate rows are merged with existing rows." } ] }, { "tag": "@param", "name": "options.count", "content": [ { "kind": "text", "text": "Count algorithm to use to count upserted rows.\n\n" }, { "kind": "code", "text": "`\"exact\"`" }, { "kind": "text", "text": ": Exact but slow count algorithm. Performs a " }, { "kind": "code", "text": "`COUNT(*)`" }, { "kind": "text", "text": " under the\nhood.\n\n" }, { "kind": "code", "text": "`\"planned\"`" }, { "kind": "text", "text": ": Approximated but fast count algorithm. Uses the Postgres\nstatistics under the hood.\n\n" }, { "kind": "code", "text": "`\"estimated\"`" }, { "kind": "text", "text": ": Uses exact count for low numbers and planned count for high\nnumbers." } ] }, { "tag": "@param", "name": "options.defaultToNull", "content": [ { "kind": "text", "text": "Make missing fields default to " }, { "kind": "code", "text": "`null`" }, { "kind": "text", "text": ".\nOtherwise, use the default value for the column. This only applies when\ninserting new rows, not when merging with existing rows under\n" }, { "kind": "code", "text": "`ignoreDuplicates: false`" }, { "kind": "text", "text": ". This also only applies when doing bulk upserts." } ] }, { "tag": "@example", "name": "Upsert a single row using a unique key", "content": [ { "kind": "code", "text": "```ts\n// Upserting a single row, overwriting based on the 'username' unique column\nconst { data, error } = await supabase\n .from('users')\n .upsert({ username: 'supabot' }, { onConflict: 'username' })\n\n// Example response:\n// {\n// data: [\n// { id: 4, message: 'bar', username: 'supabot' }\n// ],\n// error: null\n// }\n```" } ] }, { "tag": "@example", "name": "Upsert with conflict resolution and exact row counting", "content": [ { "kind": "code", "text": "```ts\n// Upserting and returning exact count\nconst { data, error, count } = await supabase\n .from('users')\n .upsert(\n {\n id: 3,\n message: 'foo',\n username: 'supabot'\n },\n {\n onConflict: 'username',\n count: 'exact'\n }\n )\n\n// Example response:\n// {\n// data: [\n// {\n// id: 42,\n// handle: \"saoirse\",\n// display_name: \"Saoirse\"\n// }\n// ],\n// count: 1,\n// error: null\n// }\n```" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Primary keys must be included in " }, { "kind": "code", "text": "`values`" }, { "kind": "text", "text": " to use upsert." } ] }, { "tag": "@example", "name": "Upsert your data", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert({ id: 1, name: 'piano' })\n .select()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Upsert your data\n" }, { "kind": "code", "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Upsert your data\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" } ] }, { "tag": "@example", "name": "Bulk Upsert your data", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('instruments')\n .upsert([\n { id: 1, name: 'piano' },\n { id: 2, name: 'harp' },\n ])\n .select()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Bulk Upsert your data\n" }, { "kind": "code", "text": "```sql\ncreate table\n instruments (id int8 primary key, name text);\n\ninsert into\n instruments (id, name)\nvalues\n (1, 'harpsichord');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Bulk Upsert your data\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"piano\"\n },\n {\n \"id\": 2,\n \"name\": \"harp\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Upserting into tables with constraints\nIn the following query, " }, { "kind": "code", "text": "`upsert()`" }, { "kind": "text", "text": " implicitly uses the " }, { "kind": "code", "text": "`id`" }, { "kind": "text", "text": "\n(primary key) column to determine conflicts. If there is no existing\nrow with the same " }, { "kind": "code", "text": "`id`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`upsert()`" }, { "kind": "text", "text": " inserts a new row, which\nwill fail in this case as there is already a row with " }, { "kind": "code", "text": "`handle`" }, { "kind": "text", "text": " " }, { "kind": "code", "text": "`\"saoirse\"`" }, { "kind": "text", "text": ".\nUsing the " }, { "kind": "code", "text": "`onConflict`" }, { "kind": "text", "text": " option, you can instruct " }, { "kind": "code", "text": "`upsert()`" }, { "kind": "text", "text": " to use\nanother column with a unique constraint to determine conflicts." } ] }, { "tag": "@example", "name": "Upserting into tables with constraints", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('users')\n .upsert({ id: 42, handle: 'saoirse', display_name: 'Saoirse' })\n .select()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Upserting into tables with constraints\n" }, { "kind": "code", "text": "```sql\ncreate table\n users (\n id int8 generated by default as identity primary key,\n handle text not null unique,\n display_name text\n );\n\ninsert into\n users (id, handle, display_name)\nvalues\n (1, 'saoirse', null);\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Upserting into tables with constraints\n" }, { "kind": "code", "text": "```json\n{\n \"error\": {\n \"code\": \"23505\",\n \"details\": \"Key (handle)=(saoirse) already exists.\",\n \"hint\": null,\n \"message\": \"duplicate key value violates unique constraint \\\"users_handle_key\\\"\"\n },\n \"status\": 409,\n \"statusText\": \"Conflict\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1099, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1099" }, { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1115, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1115" }, { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1341, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1341" } ], "signatures": [ { "id": 144, "name": "upsert", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1099, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1099" } ], "typeParameters": [ { "id": 145, "name": "Row", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 146, "name": "values", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 145, "name": "Row", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 147, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 148, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 151, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1104, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1104" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 150, "name": "ignoreDuplicates", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1103, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1103" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 149, "name": "onConflict", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1102, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1102" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [151, 150, 149] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1101, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1101" } ] } } } ], "type": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 81, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 82, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "target": 83, "name": "Relation", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relation", "refersToTypeParameter": true } }, { "type": "literal", "value": null }, { "type": "reference", "target": 84, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 85, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "literal", "value": "POST" } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } }, { "id": 152, "name": "upsert", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1115, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1115" } ], "typeParameters": [ { "id": 153, "name": "Row", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } } ], "parameters": [ { "id": 154, "name": "values", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "array", "elementType": { "type": "reference", "target": 153, "name": "Row", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } }, { "id": 155, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 156, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 159, "name": "count", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1120, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1120" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "exact" }, { "type": "literal", "value": "planned" }, { "type": "literal", "value": "estimated" } ] } }, { "id": 160, "name": "defaultToNull", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1121, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1121" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 158, "name": "ignoreDuplicates", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1119, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1119" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 157, "name": "onConflict", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1118, "character": 6, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1118" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [159, 160, 158, 157] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 1117, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1117" } ] } } } ], "type": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 81, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 82, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "indexedAccess", "indexType": { "type": "literal", "value": "Row" }, "objectType": { "type": "reference", "target": 83, "name": "Relation", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relation", "refersToTypeParameter": true } }, { "type": "literal", "value": null }, { "type": "reference", "target": 84, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 85, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "literal", "value": "POST" } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] } ], "groups": [ { "title": "Constructors", "children": [79] }, { "title": "Properties", "children": [106, 103, 104, 105, 102, 114] }, { "title": "Methods", "children": [168, 129, 120, 161, 143] } ], "categories": [ { "title": "Database", "children": [79, 168, 129, 120, 161, 143] }, { "title": "Other", "children": [106, 103, 104, 105, 102, 114] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 11, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L11" } ], "typeParameters": [ { "id": 173, "name": "ClientOptions", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" } }, { "id": 174, "name": "Schema", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" } }, { "id": 175, "name": "Relation", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericTable" }, "name": "GenericTable", "package": "@supabase/postgrest-js" }, { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericView" }, "name": "GenericView", "package": "@supabase/postgrest-js" } ] } }, { "id": 176, "name": "RelationName", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 177, "name": "Relationships", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "target": 83, "name": "Relation", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relation", "refersToTypeParameter": true }, "extendsType": { "type": "reflection", "declaration": { "id": 178, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 179, "name": "Relationships", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 16, "character": 37, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L16" } ], "type": { "type": "inferred", "name": "R" } } ], "groups": [ { "title": "Properties", "children": [179] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts", "line": 16, "character": 35, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L16" } ] } }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "R" }, "name": "R", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "intrinsic", "name": "unknown" } } } ] }, { "id": 584, "name": "PostgrestTransformBuilder", "variant": "declaration", "kind": 128, "flags": {}, "children": [ { "id": 585, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 57, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L57" } ], "signatures": [ { "id": 586, "name": "PostgrestTransformBuilder", "variant": "signature", "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Creates a builder configured for a specific PostgREST request." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'public-anon-key' }) }\n)\n```" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "Creating a Postgrest query builder", "content": [ { "kind": "code", "text": "```ts\nimport { PostgrestQueryBuilder } from '@supabase/postgrest-js'\n\nconst builder = new PostgrestQueryBuilder(\n new URL('https://xyzcompany.supabase.co/rest/v1/users'),\n { headers: new Headers({ apikey: 'public-anon-key' }) }\n)\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 57, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L57" } ], "typeParameters": [ { "id": 587, "name": "ClientOptions", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" } }, { "id": 588, "name": "Schema", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" } }, { "id": 589, "name": "Row", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } }, { "id": 590, "name": "Result", "variant": "typeParam", "kind": 131072, "flags": {} }, { "id": 591, "name": "RelationName", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 592, "name": "Relationships", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 593, "name": "Method", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "parameters": [ { "id": 594, "name": "builder", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { "id": 595, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 600, "name": "body", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 62, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L62" } ], "type": { "type": "intrinsic", "name": "unknown" } }, { "id": 603, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 65, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L65" } ], "type": { "type": "reflection", "declaration": { "id": 604, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 605, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 606, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" } ] } }, { "id": 607, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 608, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 609, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" } ] } }, { "id": 610, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } } }, { "id": 598, "name": "headers", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 60, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L60" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "HeadersInit" }, "name": "HeadersInit", "package": "typescript" } }, { "id": 611, "name": "isMaybeSingle", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 66, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L66" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 596, "name": "method", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 58, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L58" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] } }, { "id": 599, "name": "schema", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 61, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L61" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 601, "name": "shouldThrowOnError", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 63, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L63" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 602, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 64, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L64" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" } }, { "id": 597, "name": "url", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 59, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L59" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" } }, { "id": 612, "name": "urlLengthLimit", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 67, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L67" } ], "type": { "type": "intrinsic", "name": "number" } } ], "groups": [ { "title": "Properties", "children": [600, 603, 598, 611, 596, 599, 601, 602, 597, 612] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 57, "character": 23, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L57" } ] } } } ], "type": { "type": "reference", "target": 584, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 588, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 589, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 591, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 592, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 593, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true } ], "name": "PostgrestTransformBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": 747, "name": "default.constructor" } } ], "inheritedFrom": { "type": "reference", "target": 746, "name": "default.constructor" } }, { "id": 699, "name": "body", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isOptional": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 25, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L25" } ], "type": { "type": "intrinsic", "name": "unknown" }, "inheritedFrom": { "type": "reference", "target": 774, "name": "default.body" } }, { "id": 702, "name": "fetch", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 28, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L28" } ], "type": { "type": "reflection", "declaration": { "id": 703, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 }, { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "signatures": [ { "id": 704, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/typescript/lib/lib.dom.d.ts", "line": 29329, "character": 17 } ], "parameters": [ { "id": 705, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInfo" }, "name": "RequestInfo", "package": "typescript" } ] } }, { "id": 706, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } }, { "id": 707, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "[MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/fetch)" } ] }, "sources": [ { "fileName": "node_modules/@types/node/globals.d.ts", "line": 289, "character": 13 } ], "parameters": [ { "id": 708, "name": "input", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "union", "types": [ { "type": "intrinsic", "name": "string" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Request" }, "name": "Request", "package": "typescript" } ] } }, { "id": 709, "name": "init", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "RequestInit" }, "name": "RequestInit", "package": "typescript" } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Promise" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Response" }, "name": "Response", "package": "typescript" } ], "name": "Promise", "package": "typescript" } } ] } }, "inheritedFrom": { "type": "reference", "target": 777, "name": "default.fetch" } }, { "id": 697, "name": "headers", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 23, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L23" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "Headers" }, "name": "Headers", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 772, "name": "default.headers" } }, { "id": 710, "name": "isMaybeSingle", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 29, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L29" } ], "type": { "type": "intrinsic", "name": "boolean" }, "inheritedFrom": { "type": "reference", "target": 785, "name": "default.isMaybeSingle" } }, { "id": 695, "name": "method", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 21, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L21" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "GET" }, { "type": "literal", "value": "HEAD" }, { "type": "literal", "value": "POST" }, { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" } ] }, "inheritedFrom": { "type": "reference", "target": 770, "name": "default.method" } }, { "id": 698, "name": "schema", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isOptional": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 24, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L24" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": 773, "name": "default.schema" } }, { "id": 700, "name": "shouldThrowOnError", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 26, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L26" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false", "inheritedFrom": { "type": "reference", "target": 775, "name": "default.shouldThrowOnError" } }, { "id": 701, "name": "signal", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isOptional": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 27, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L27" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 776, "name": "default.signal" } }, { "id": 696, "name": "url", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 22, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L22" } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "URL" }, "name": "URL", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 771, "name": "default.url" } }, { "id": 711, "name": "urlLengthLimit", "variant": "declaration", "kind": 1024, "flags": { "isProtected": true, "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 30, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L30" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": 786, "name": "default.urlLengthLimit" } }, { "id": 664, "name": "abortSignal", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 593, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L593" } ], "signatures": [ { "id": 665, "name": "abortSignal", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Set the AbortSignal for the fetch request." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "You can use this to set a timeout for the request." } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Aborting requests in-flight\nYou can use an [" }, { "kind": "code", "text": "`AbortController`" }, { "kind": "text", "text": "](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) to abort requests.\nNote that " }, { "kind": "code", "text": "`status`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`statusText`" }, { "kind": "text", "text": " don't mean anything for aborted requests as the request wasn't fulfilled." } ] }, { "tag": "@example", "name": "Aborting requests in-flight", "content": [ { "kind": "code", "text": "```ts\nconst ac = new AbortController()\n\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(ac.signal)\n\n// Abort the request after 100 ms\nsetTimeout(() => ac.abort(), 100)\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Aborting requests in-flight\n" }, { "kind": "code", "text": "```json\n {\n \"error\": {\n \"message\": \"AbortError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"The request was aborted locally via the provided AbortSignal.\",\n \"code\": \"\"\n },\n \"status\": 0,\n \"statusText\": \"\"\n }\n\n```" } ] }, { "tag": "@example", "name": "Set a timeout", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('very_big_table')\n .select()\n .abortSignal(AbortSignal.timeout(1000 /* ms */))\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Set a timeout\n" }, { "kind": "code", "text": "```json\n {\n \"error\": {\n \"message\": \"FetchError: The user aborted a request.\",\n \"details\": \"\",\n \"hint\": \"\",\n \"code\": \"\"\n },\n \"status\": 400,\n \"statusText\": \"Bad Request\"\n }\n\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 593, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L593" } ], "parameters": [ { "id": 666, "name": "signal", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The AbortSignal to use for the fetch request" } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "AbortSignal" }, "name": "AbortSignal", "package": "typescript" } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 673, "name": "csv", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 732, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L732" } ], "signatures": [ { "id": 674, "name": "csv", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Return " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " as a string in CSV format." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Return data as CSV\nBy default, the data is returned in JSON format, but can also be returned as Comma Separated Values." } ] }, { "tag": "@example", "name": "Return data as CSV", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .csv()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Return data as CSV\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Return data as CSV\n" }, { "kind": "code", "text": "```json\n{\n \"data\": \"id,name\\n1,Luke\\n2,Leia\\n3,Han\",\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 732, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L732" } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "string" } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 677, "name": "explain", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 842, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L842" } ], "signatures": [ { "id": 678, "name": "explain", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Return " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " as the EXPLAIN plan for the query.\n\nYou need to enable the\n[db_plan_enabled](https://supabase.com/docs/guides/database/debugging-performance#enabling-explain)\nsetting before using this method." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Get the execution plan\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " }, { "kind": "code", "text": "`format`" }, { "kind": "text", "text": " parameter." } ] }, { "tag": "@example", "name": "Get the execution plan", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Get the execution plan\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Get the execution plan\n" }, { "kind": "code", "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112)\n -> Limit (cost=0.00..18.33 rows=1000 width=40)\n -> Seq Scan on characters (cost=0.00..22.00 rows=1200 width=40)\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Get the execution plan with analyze and verbose\nBy default, the data is returned in TEXT format, but can also be returned as JSON by using the " }, { "kind": "code", "text": "`format`" }, { "kind": "text", "text": " parameter." } ] }, { "tag": "@example", "name": "Get the execution plan with analyze and verbose", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .explain({analyze:true,verbose:true})\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Get the execution plan with analyze and verbose\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Get the execution plan with analyze and verbose\n" }, { "kind": "code", "text": "```js\nAggregate (cost=33.34..33.36 rows=1 width=112) (actual time=0.041..0.041 rows=1 loops=1)\n Output: NULL::bigint, count(ROW(characters.id, characters.name)), COALESCE(json_agg(ROW(characters.id, characters.name)), '[]'::json), NULLIF(current_setting('response.headers'::text, true), ''::text), NULLIF(current_setting('response.status'::text, true), ''::text)\n -> Limit (cost=0.00..18.33 rows=1000 width=40) (actual time=0.005..0.006 rows=3 loops=1)\n Output: characters.id, characters.name\n -> Seq Scan on public.characters (cost=0.00..22.00 rows=1200 width=40) (actual time=0.004..0.005 rows=3 loops=1)\n Output: characters.id, characters.name\nQuery Identifier: -4730654291623321173\nPlanning Time: 0.407 ms\nExecution Time: 0.119 ms\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 842, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L842" } ], "parameters": [ { "id": 679, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 680, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 681, "name": "analyze", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", the query will be executed and the\nactual run time will be returned" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 850, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L850" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 684, "name": "buffers", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", include information on buffer usage" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 853, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L853" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 686, "name": "format", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The format of the output, can be " }, { "kind": "code", "text": "`\"text\"`" }, { "kind": "text", "text": " (default)\nor " }, { "kind": "code", "text": "`\"json\"`" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 855, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L855" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": "text" }, { "type": "literal", "value": "json" } ] }, "defaultValue": "'text'" }, { "id": 683, "name": "settings", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", include information on configuration\nparameters that affect query planning" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 852, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L852" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 682, "name": "verbose", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", the query identifier will be returned\nand " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " will include the output columns of the query" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 851, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" }, { "id": 685, "name": "wal", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", include information on WAL record generation" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 854, "character": 4, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L854" } ], "type": { "type": "intrinsic", "name": "boolean" }, "defaultValue": "false" } ], "groups": [ { "title": "Properties", "children": [681, 684, 686, 683, 682, 685] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 849, "character": 5, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L849" } ] } }, "defaultValue": "{}" } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "intrinsic", "name": "string" }, { "type": "literal", "value": false } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } }, { "type": "literal", "value": false } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } ] } } ] }, { "id": 675, "name": "geojson", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 742, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L742" } ], "signatures": [ { "id": 676, "name": "geojson", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Return " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " as an object in [GeoJSON](https://geojson.org) format." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 742, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L742" } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 649, "name": "limit", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 445, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L445" } ], "signatures": [ { "id": 650, "name": "limit", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Limit the query result by " }, { "kind": "code", "text": "`count`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@example", "name": "On a referenced table", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .limit(1, { referencedTable: 'instruments' })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On a referenced table\n" }, { "kind": "code", "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On a referenced table\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n }\n ]\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 445, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L445" } ], "parameters": [ { "id": 651, "name": "count", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The maximum number of rows to return" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 652, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 653, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 654, "name": "foreignTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Deprecated, use " }, { "kind": "code", "text": "`options.referencedTable`" }, { "kind": "text", "text": "\ninstead" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 450, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L450" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 655, "name": "referencedTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Set this to limit rows of referenced\ntables instead of the parent table" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 450, "character": 32, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L450" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "foreignTable" } ], "groups": [ { "title": "Properties", "children": [654, 655] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 450, "character": 7, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L450" } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 692, "name": "maxAffected", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 957, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L957" } ], "signatures": [ { "id": 693, "name": "maxAffected", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Set the maximum number of rows that can be affected by the query.\nOnly available in PostgREST v13+ and only works with PATCH and DELETE methods." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 957, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L957" } ], "parameters": [ { "id": 694, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The maximum number of rows that can be affected" } ] }, "type": { "type": "intrinsic", "name": "number" } } ], "type": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/types/feature-flags.ts", "qualifiedName": "MaxAffectedEnabled" }, "typeArguments": [ { "type": "indexedAccess", "indexType": { "type": "literal", "value": "PostgrestVersion" }, "objectType": { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true } } ], "name": "MaxAffectedEnabled", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": 593, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true }, "extendsType": { "type": "union", "types": [ { "type": "literal", "value": "PATCH" }, { "type": "literal", "value": "DELETE" }, { "type": "literal", "value": "RPC" } ] }, "trueType": { "type": "reference", "target": 584, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 588, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 589, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 591, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 592, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 593, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true } ], "name": "PostgrestTransformBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "InvalidMethodError" }, "typeArguments": [ { "type": "literal", "value": "maxAffected method only available on update or delete" } ], "name": "InvalidMethodError", "package": "@supabase/postgrest-js" } }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "InvalidMethodError" }, "typeArguments": [ { "type": "literal", "value": "maxAffected method only available on postgrest 13+" } ], "name": "InvalidMethodError", "package": "@supabase/postgrest-js" } } } ] }, { "id": 670, "name": "maybeSingle", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 685, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L685" } ], "signatures": [ { "id": 671, "name": "maybeSingle", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Return " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " as a single object instead of an array of objects.\n\nQuery result must be zero or one row (e.g. using " }, { "kind": "code", "text": "`.limit(1)`" }, { "kind": "text", "text": "), otherwise\nthis returns an error." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .eq('name', 'Katniss')\n .maybeSingle()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 685, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L685" } ], "typeParameters": [ { "id": 672, "name": "ResultOne", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, "extendsType": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": 511, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ] } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 618, "name": "order", "variant": "declaration", "kind": 2048, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Order the query result by " }, { "kind": "code", "text": "`column`" }, { "kind": "text", "text": ".\n\nYou can call this method multiple times to order by multiple columns.\n\nYou can order referenced tables, but it only affects the ordering of the\nparent table if you use " }, { "kind": "code", "text": "`!inner`" }, { "kind": "text", "text": " in the query." } ], "blockTags": [ { "tag": "@param", "name": "column", "content": [ { "kind": "text", "text": "The column to order by" } ] }, { "tag": "@param", "name": "options", "content": [ { "kind": "text", "text": "Named parameters" } ] }, { "tag": "@param", "name": "options.ascending", "content": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", the result will be in ascending order" } ] }, { "tag": "@param", "name": "options.nullsFirst", "content": [ { "kind": "text", "text": "If " }, { "kind": "code", "text": "`true`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`null`" }, { "kind": "text", "text": "s appear first. If " }, { "kind": "code", "text": "`false`" }, { "kind": "text", "text": ",\n" }, { "kind": "code", "text": "`null`" }, { "kind": "text", "text": "s appear last." } ] }, { "tag": "@param", "name": "options.referencedTable", "content": [ { "kind": "text", "text": "Set this to order a referenced table by\nits columns" } ] }, { "tag": "@param", "name": "options.foreignTable", "content": [ { "kind": "text", "text": "Deprecated, use " }, { "kind": "code", "text": "`options.referencedTable`" }, { "kind": "text", "text": "\ninstead" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('id, name')\n .order('id', { ascending: false })\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 3,\n \"name\": \"Han\"\n },\n {\n \"id\": 2,\n \"name\": \"Leia\"\n },\n {\n \"id\": 1,\n \"name\": \"Luke\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "On a referenced table\nOrdering with " }, { "kind": "code", "text": "`referencedTable`" }, { "kind": "text", "text": " doesn't affect the ordering of the\nparent table." } ] }, { "tag": "@example", "name": "On a referenced table", "content": [ { "kind": "code", "text": "```ts\n const { data, error } = await supabase\n .from('orchestral_sections')\n .select(`\n name,\n instruments (\n name\n )\n `)\n .order('name', { referencedTable: 'instruments', ascending: false })\n\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "On a referenced table\n" }, { "kind": "code", "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 1, 'harp'),\n (2, 1, 'violin');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "On a referenced table\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"strings\",\n \"instruments\": [\n {\n \"name\": \"violin\"\n },\n {\n \"name\": \"harp\"\n }\n ]\n },\n {\n \"name\": \"woodwinds\",\n \"instruments\": []\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] }, { "tag": "@exampleDescription", "content": [ { "kind": "text", "text": "Order parent table by a referenced table\nOrdering with " }, { "kind": "code", "text": "`referenced_table(col)`" }, { "kind": "text", "text": " affects the ordering of the\nparent table." } ] }, { "tag": "@example", "name": "Order parent table by a referenced table", "content": [ { "kind": "code", "text": "```ts\n const { data, error } = await supabase\n .from('instruments')\n .select(`\n name,\n section:orchestral_sections (\n name\n )\n `)\n .order('section(name)', { ascending: true })\n\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "Order parent table by a referenced table\n" }, { "kind": "code", "text": "```sql\ncreate table\n orchestral_sections (id int8 primary key, name text);\ncreate table\n instruments (\n id int8 primary key,\n section_id int8 not null references orchestral_sections,\n name text\n );\n\ninsert into\n orchestral_sections (id, name)\nvalues\n (1, 'strings'),\n (2, 'woodwinds');\ninsert into\n instruments (id, section_id, name)\nvalues\n (1, 2, 'flute'),\n (2, 1, 'violin');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Order parent table by a referenced table\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"violin\",\n \"orchestral_sections\": {\"name\": \"strings\"}\n },\n {\n \"name\": \"flute\",\n \"orchestral_sections\": {\"name\": \"woodwinds\"}\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 110, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L110" }, { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 114, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L114" }, { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 121, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L121" }, { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 128, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L128" }, { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 320, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L320" } ], "signatures": [ { "id": 619, "name": "order", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 110, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L110" } ], "typeParameters": [ { "id": 620, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 621, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 459, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 622, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 623, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 624, "name": "ascending", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 112, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L112" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 625, "name": "nullsFirst", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 112, "character": 37, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L112" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 626, "name": "referencedTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 112, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L112" } ], "type": { "type": "intrinsic", "name": "undefined" } } ], "groups": [ { "title": "Properties", "children": [624, 625, 626] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 112, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L112" } ] } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 627, "name": "order", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 114, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L114" } ], "parameters": [ { "id": 628, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 629, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 630, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 631, "name": "ascending", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 116, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L116" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 632, "name": "nullsFirst", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 116, "character": 37, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L116" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 633, "name": "referencedTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 116, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L116" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [631, 632, 633] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 116, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L116" } ] } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 634, "name": "order", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Use " }, { "kind": "code", "text": "`options.referencedTable`" }, { "kind": "text", "text": " instead of " }, { "kind": "code", "text": "`options.foreignTable`" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 121, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L121" } ], "typeParameters": [ { "id": 635, "name": "ColumnName", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "parameters": [ { "id": 636, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 474, "name": "ColumnName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, { "id": 637, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 638, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 639, "name": "ascending", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 123, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L123" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 641, "name": "foreignTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 123, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L123" } ], "type": { "type": "intrinsic", "name": "undefined" } }, { "id": 640, "name": "nullsFirst", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 123, "character": 37, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L123" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [639, 641, 640] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 123, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L123" } ] } } } ], "type": { "type": "intrinsic", "name": "this" } }, { "id": 642, "name": "order", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Use " }, { "kind": "code", "text": "`options.referencedTable`" }, { "kind": "text", "text": " instead of " }, { "kind": "code", "text": "`options.foreignTable`" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 128, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L128" } ], "parameters": [ { "id": 643, "name": "column", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 644, "name": "options", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "reflection", "declaration": { "id": 645, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 646, "name": "ascending", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 130, "character": 16, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L130" } ], "type": { "type": "intrinsic", "name": "boolean" } }, { "id": 648, "name": "foreignTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 130, "character": 59, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L130" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 647, "name": "nullsFirst", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 130, "character": 37, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L130" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [646, 648, 647] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 130, "character": 14, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L130" } ] } } } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 730, "name": "overrideTypes", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 424, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L424" } ], "signatures": [ { "id": 731, "name": "overrideTypes", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Override the type of the returned " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " field in the response." } ], "blockTags": [ { "tag": "@example", "content": [ { "kind": "code", "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" } ] }, { "tag": "@returns", "content": [ { "kind": "text", "text": "A PostgrestBuilder instance with the new type" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "Complete Override type of successful response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes, { merge: false }>()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Complete Override type of successful response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // MyType[]\n```" } ] }, { "tag": "@example", "name": "Complete Override type of object response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Complete Override type of object response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // MyType | null\n```" } ] }, { "tag": "@example", "name": "Partial Override type of successful response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .overrideTypes>()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Partial Override type of successful response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // Array\n```" } ] }, { "tag": "@example", "name": "Partial Override type of object response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .overrideTypes<{ status: \"A\" | \"B\" }>()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Partial Override type of object response\n" }, { "kind": "code", "text": "```ts\nlet x: typeof data // CountryRowProperties & { status: \"A\" | \"B\" } | null\n```" } ] }, { "tag": "@example", "name": "Example 5", "content": [ { "kind": "code", "text": "```typescript\n// Merge with existing types (default behavior)\nconst query = supabase\n .from('users')\n .select()\n .overrideTypes<{ custom_field: string }>()\n\n// Replace existing types completely\nconst replaceQuery = supabase\n .from('users')\n .select()\n .overrideTypes<{ id: number; name: string }, { merge: false }>()\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 424, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L424" } ], "typeParameters": [ { "id": 732, "name": "NewResult", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The new type to cast the response data to" } ] } }, { "id": 733, "name": "Options", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Optional type configuration (defaults to { merge: true })" } ] }, "type": { "type": "reflection", "declaration": { "id": 734, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 735, "name": "merge", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 22, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ], "type": { "type": "intrinsic", "name": "boolean" } } ], "groups": [ { "title": "Properties", "children": [735] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 20, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ] } }, "default": { "type": "reflection", "declaration": { "id": 736, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 737, "name": "merge", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 44, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ], "type": { "type": "literal", "value": true } } ], "groups": [ { "title": "Properties", "children": [737] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 426, "character": 42, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L426" } ] } } } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "IsValidResultOverride" }, "typeArguments": [ { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "literal", "value": false }, { "type": "literal", "value": false } ], "name": "IsValidResultOverride", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/types.ts", "qualifiedName": "ContainsNull" }, "typeArguments": [ { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "ContainsNull", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "MergePartialResult" }, "typeArguments": [ { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "NonNullable" }, "typeArguments": [ { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "NonNullable", "package": "typescript" }, { "type": "reference", "target": 572, "name": "Options", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "MergePartialResult", "package": "@supabase/postgrest-js" } ] }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "MergePartialResult" }, "typeArguments": [ { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 572, "name": "Options", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "MergePartialResult", "package": "@supabase/postgrest-js" } }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "CheckMatchingArrayTypes" }, "typeArguments": [ { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 571, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "CheckMatchingArrayTypes", "package": "@supabase/postgrest-js" } }, { "type": "literal", "value": false } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "inheritedFrom": { "type": "reference", "target": 809, "name": "default.overrideTypes" } } ], "inheritedFrom": { "type": "reference", "target": 808, "name": "default.overrideTypes" } }, { "id": 656, "name": "range", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 511, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L511" } ], "signatures": [ { "id": 657, "name": "range", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Limit the query result by starting at an offset " }, { "kind": "code", "text": "`from`" }, { "kind": "text", "text": " and ending at the offset " }, { "kind": "code", "text": "`to`" }, { "kind": "text", "text": ".\nOnly records within this range are returned.\nThis respects the query order and if there is no order clause the range could behave unexpectedly.\nThe " }, { "kind": "code", "text": "`from`" }, { "kind": "text", "text": " and " }, { "kind": "code", "text": "`to`" }, { "kind": "text", "text": " values are 0-based and inclusive: " }, { "kind": "code", "text": "`range(1, 3)`" }, { "kind": "text", "text": " will include the second, third\nand fourth rows of the query." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .range(0, 1)\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"name\": \"Luke\"\n },\n {\n \"name\": \"Leia\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 511, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L511" } ], "parameters": [ { "id": 658, "name": "from", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The starting index from which to limit the result" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 659, "name": "to", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The last index to which to limit the result" } ] }, "type": { "type": "intrinsic", "name": "number" } }, { "id": 660, "name": "options", "variant": "param", "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Named parameters" } ] }, "type": { "type": "reflection", "declaration": { "id": 661, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 662, "name": "foreignTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Deprecated, use " }, { "kind": "code", "text": "`options.referencedTable`" }, { "kind": "text", "text": "\ninstead" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 517, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L517" } ], "type": { "type": "intrinsic", "name": "string" } }, { "id": 663, "name": "referencedTable", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "Set this to limit rows of referenced\ntables instead of the parent table" } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 517, "character": 32, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L517" } ], "type": { "type": "intrinsic", "name": "string" }, "defaultValue": "foreignTable" } ], "groups": [ { "title": "Properties", "children": [662, 663] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 517, "character": 7, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L517" } ] } }, "defaultValue": "{}" } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 689, "name": "returns", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 929, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L929" } ], "signatures": [ { "id": 690, "name": "returns", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Override the type of the returned " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@deprecated", "content": [ { "kind": "text", "text": "Use overrideTypes() method at the end of your call chain instead" } ] }, { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@remarks", "content": [ { "kind": "text", "text": "- Deprecated: use overrideTypes method instead" } ] }, { "tag": "@example", "name": "Override type of successful response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .returns>()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Override type of successful response\n" }, { "kind": "code", "text": "```js\nlet x: typeof data // MyType[]\n```" } ] }, { "tag": "@example", "name": "Override type of object response", "content": [ { "kind": "code", "text": "```ts\nconst { data } = await supabase\n .from('countries')\n .select()\n .maybeSingle()\n .returns()\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "Override type of object response\n" }, { "kind": "code", "text": "```js\nlet x: typeof data // MyType | null\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 929, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L929" } ], "typeParameters": [ { "id": 691, "name": "NewResult", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The new result type to override with" } ] } } ], "type": { "type": "reference", "target": 584, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 588, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 589, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "CheckMatchingArrayTypes" }, "typeArguments": [ { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 530, "name": "NewResult", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "CheckMatchingArrayTypes", "package": "@supabase/postgrest-js" }, { "type": "reference", "target": 591, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 592, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 593, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true } ], "name": "PostgrestTransformBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, "overwrites": { "type": "reference", "target": 806, "name": "default.returns" } } ], "overwrites": { "type": "reference", "target": 805, "name": "default.returns" } }, { "id": 687, "name": "rollback", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 886, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L886" } ], "signatures": [ { "id": 688, "name": "rollback", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Rollback the query.\n\n" }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " will still be returned, but the query is not committed." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 886, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L886" } ], "type": { "type": "intrinsic", "name": "this" } } ] }, { "id": 613, "name": "select", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 61, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L61" } ], "signatures": [ { "id": 614, "name": "select", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Perform a SELECT on the query result.\n\nBy default, " }, { "kind": "code", "text": "`.insert()`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`.update()`" }, { "kind": "text", "text": ", " }, { "kind": "code", "text": "`.upsert()`" }, { "kind": "text", "text": ", and " }, { "kind": "code", "text": "`.delete()`" }, { "kind": "text", "text": " do not\nreturn modified rows. By calling this method, modified rows are returned in\n" }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": "." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `upsert()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .upsert({ id: 1, name: 'Han Solo' })\n .select()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`upsert()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`upsert()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Han Solo\"\n }\n ],\n \"status\": 201,\n \"statusText\": \"Created\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 61, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L61" } ], "typeParameters": [ { "id": 615, "name": "Query", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "intrinsic", "name": "string" }, "default": { "type": "literal", "value": "*" } }, { "id": 616, "name": "NewResultOne", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 853, "typeArguments": [ { "type": "reference", "target": 588, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 589, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 591, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 592, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 454, "name": "Query", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true } ], "name": "GetResult", "package": "@supabase/postgrest-js" } } ], "parameters": [ { "id": 617, "name": "columns", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "comment": { "summary": [ { "kind": "text", "text": "The columns to retrieve, separated by commas" } ] }, "type": { "type": "reference", "target": 454, "name": "Query", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } ], "type": { "type": "reference", "target": 180, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 588, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 589, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "conditional", "checkType": { "type": "reference", "target": 593, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true }, "extendsType": { "type": "literal", "value": "RPC" }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, "extendsType": { "type": "array", "elementType": { "type": "intrinsic", "name": "unknown" } }, "trueType": { "type": "array", "elementType": { "type": "reference", "target": 455, "name": "NewResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "falseType": { "type": "reference", "target": 455, "name": "NewResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "falseType": { "type": "array", "elementType": { "type": "reference", "target": 455, "name": "NewResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } }, { "type": "reference", "target": 591, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 592, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 593, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true } ], "name": "PostgrestFilterBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 714, "name": "setHeader", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 104, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L104" } ], "signatures": [ { "id": 715, "name": "setHeader", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "Set an HTTP header for the request." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 104, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L104" } ], "parameters": [ { "id": 716, "name": "name", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { "id": 717, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "string" } } ], "type": { "type": "intrinsic", "name": "this" }, "inheritedFrom": { "type": "reference", "target": 790, "name": "default.setHeader" } } ], "inheritedFrom": { "type": "reference", "target": 789, "name": "default.setHeader" } }, { "id": 667, "name": "single", "variant": "declaration", "kind": 2048, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 639, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L639" } ], "signatures": [ { "id": 668, "name": "single", "variant": "signature", "kind": 4096, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Return " }, { "kind": "code", "text": "`data`" }, { "kind": "text", "text": " as a single object instead of an array of objects.\n\nQuery result must be one row (e.g. using " }, { "kind": "code", "text": "`.limit(1)`" }, { "kind": "text", "text": "), otherwise this\nreturns an error." } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] }, { "tag": "@example", "name": "With `select()`", "content": [ { "kind": "code", "text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select('name')\n .limit(1)\n .single()\n```" } ] }, { "tag": "@exampleSql", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```sql\ncreate table\n characters (id int8 primary key, name text);\n\ninsert into\n characters (id, name)\nvalues\n (1, 'Luke'),\n (2, 'Leia'),\n (3, 'Han');\n```" } ] }, { "tag": "@exampleResponse", "content": [ { "kind": "text", "text": "With " }, { "kind": "code", "text": "`select()`" }, { "kind": "text", "text": "\n" }, { "kind": "code", "text": "```json\n{\n \"data\": {\n \"name\": \"Luke\"\n },\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 639, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L639" } ], "typeParameters": [ { "id": 669, "name": "ResultOne", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "conditional", "checkType": { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, "extendsType": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "intrinsic", "name": "never" } } } ], "type": { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 508, "name": "ResultOne", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } } ] }, { "id": 718, "name": "then", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 113, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" } ], "signatures": [ { "id": 719, "name": "then", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 113, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L113" } ], "typeParameters": [ { "id": 720, "name": "TResult1", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "reference", "target": 846, "typeArguments": [ { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "PostgrestSingleResponse", "package": "@supabase/postgrest-js" } }, { "id": 721, "name": "TResult2", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "never" } } ], "parameters": [ { "id": 722, "name": "onfulfilled", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 723, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 120, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" } ], "signatures": [ { "id": 724, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 120, "character": 9, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120" } ], "parameters": [ { "id": 725, "name": "value", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": 846, "typeArguments": [ { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "PostgrestSingleResponse", "package": "@supabase/postgrest-js" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 559, "name": "TResult1", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 559, "name": "TResult1", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "PromiseLike", "package": "typescript" } ] } } ] } } ] } }, { "id": 726, "name": "onrejected", "variant": "param", "kind": 32768, "flags": { "isOptional": true }, "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "reflection", "declaration": { "id": 727, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 127, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L127" } ], "signatures": [ { "id": 728, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 127, "character": 18, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L127" } ], "parameters": [ { "id": 729, "name": "reason", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "intrinsic", "name": "any" } } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 560, "name": "TResult2", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "reference", "target": 560, "name": "TResult2", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "PromiseLike", "package": "typescript" } ] } } ] } } ] } } ], "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "PromiseLike" }, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": 559, "name": "TResult1", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 560, "name": "TResult2", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ] } ], "name": "PromiseLike", "package": "typescript" }, "inheritedFrom": { "type": "reference", "target": 794, "name": "default.then" } } ], "inheritedFrom": { "type": "reference", "target": 793, "name": "default.then" } }, { "id": 712, "name": "throwOnError", "variant": "declaration", "kind": 2048, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 94, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L94" } ], "signatures": [ { "id": 713, "name": "throwOnError", "variant": "signature", "kind": 4096, "flags": { "isInherited": true }, "comment": { "summary": [ { "kind": "text", "text": "If there's an error with the query, throwOnError will reject the promise by\nthrowing the error instead of returning it as part of a successful response.\n\n" }, { "kind": "inline-tag", "tag": "@link", "text": "https://github.com/supabase/supabase-js/issues/92", "target": "https://github.com/supabase/supabase-js/issues/92" } ], "blockTags": [ { "tag": "@category", "content": [ { "kind": "text", "text": "Database" } ] } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts", "line": 94, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestBuilder.ts#L94" } ], "type": { "type": "intersection", "types": [ { "type": "reference", "target": 584, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 588, "name": "Schema", "package": "@supabase/postgrest-js", "qualifiedName": "default.Schema", "refersToTypeParameter": true }, { "type": "reference", "target": 589, "name": "Row", "package": "@supabase/postgrest-js", "qualifiedName": "default.Row", "refersToTypeParameter": true }, { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "reference", "target": 591, "name": "RelationName", "package": "@supabase/postgrest-js", "qualifiedName": "default.RelationName", "refersToTypeParameter": true }, { "type": "reference", "target": 592, "name": "Relationships", "package": "@supabase/postgrest-js", "qualifiedName": "default.Relationships", "refersToTypeParameter": true }, { "type": "reference", "target": 593, "name": "Method", "package": "@supabase/postgrest-js", "qualifiedName": "default.Method", "refersToTypeParameter": true } ], "name": "PostgrestTransformBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" }, { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true }, { "type": "literal", "value": true } ], "name": "PostgrestBuilder", "package": "@supabase/postgrest-js", "qualifiedName": "default" } ] }, "inheritedFrom": { "type": "reference", "target": 788, "name": "default.throwOnError" } } ], "inheritedFrom": { "type": "reference", "target": 787, "name": "default.throwOnError" } } ], "groups": [ { "title": "Constructors", "children": [585] }, { "title": "Properties", "children": [699, 702, 697, 710, 695, 698, 700, 701, 696, 711] }, { "title": "Methods", "children": [ 664, 673, 677, 675, 649, 692, 670, 618, 730, 656, 689, 687, 613, 714, 667, 718, 712 ] } ], "categories": [ { "title": "Database", "children": [ 585, 664, 673, 677, 675, 649, 692, 670, 618, 730, 656, 689, 687, 613, 714, 667, 718, 712 ] }, { "title": "Other", "children": [699, 702, 697, 710, 695, 698, 700, 701, 696, 711] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts", "line": 8, "character": 21, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L8" } ], "typeParameters": [ { "id": 738, "name": "ClientOptions", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" } }, { "id": 739, "name": "Schema", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" } }, { "id": 740, "name": "Row", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } }, { "id": 741, "name": "Result", "variant": "typeParam", "kind": 131072, "flags": {} }, { "id": 742, "name": "RelationName", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 743, "name": "Relationships", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } }, { "id": 744, "name": "Method", "variant": "typeParam", "kind": 131072, "flags": {}, "default": { "type": "intrinsic", "name": "unknown" } } ], "extendedTypes": [ { "type": "reference", "target": 745, "typeArguments": [ { "type": "reference", "target": 587, "name": "ClientOptions", "package": "@supabase/postgrest-js", "qualifiedName": "default.ClientOptions", "refersToTypeParameter": true }, { "type": "reference", "target": 590, "name": "Result", "package": "@supabase/postgrest-js", "qualifiedName": "default.Result", "refersToTypeParameter": true } ], "name": "default", "package": "@supabase/postgrest-js" } ], "extendedBy": [ { "type": "reference", "target": 180, "name": "PostgrestFilterBuilder" } ] }, { "id": 833, "name": "PostgrestResponseFailure", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 836, "name": "count", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 23, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L23" } ], "type": { "type": "literal", "value": null } }, { "id": 835, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 22, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L22" } ], "type": { "type": "literal", "value": null } }, { "id": 834, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L21" } ], "type": { "type": "reference", "target": 819, "name": "PostgrestError", "package": "@supabase/postgrest-js", "qualifiedName": "default" } }, { "id": 837, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 12, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L12" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "PostgrestResponseBase.status" } }, { "id": 838, "name": "statusText", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 13, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L13" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "PostgrestResponseBase.statusText" } } ], "groups": [ { "title": "Properties", "children": [836, 835, 834, 837, 838] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 20, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L20" } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseBase" }, "name": "PostgrestResponseBase", "package": "@supabase/postgrest-js" } ] }, { "id": 839, "name": "PostgrestResponseSuccess", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 842, "name": "count", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 18, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L18" } ], "type": { "type": "union", "types": [ { "type": "literal", "value": null }, { "type": "intrinsic", "name": "number" } ] } }, { "id": 841, "name": "data", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 17, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L17" } ], "type": { "type": "reference", "target": 845, "name": "T", "package": "@supabase/postgrest-js", "qualifiedName": "PostgrestResponseSuccess.T", "refersToTypeParameter": true } }, { "id": 840, "name": "error", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 16, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L16" } ], "type": { "type": "literal", "value": null } }, { "id": 843, "name": "status", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 12, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L12" } ], "type": { "type": "intrinsic", "name": "number" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "PostgrestResponseBase.status" } }, { "id": 844, "name": "statusText", "variant": "declaration", "kind": 1024, "flags": { "isInherited": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 13, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L13" } ], "type": { "type": "intrinsic", "name": "string" }, "inheritedFrom": { "type": "reference", "target": -1, "name": "PostgrestResponseBase.statusText" } } ], "groups": [ { "title": "Properties", "children": [842, 841, 840, 843, 844] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 15, "character": 17, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L15" } ], "typeParameters": [ { "id": 845, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "extendedTypes": [ { "type": "reference", "target": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseBase" }, "name": "PostgrestResponseBase", "package": "@supabase/postgrest-js" } ] }, { "id": 850, "name": "PostgrestClientOptions", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/common/common.ts", "line": 54, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/common/common.ts#L54" } ], "type": { "type": "reflection", "declaration": { "id": 851, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 852, "name": "PostgrestVersion", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/common/common.ts", "line": 55, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/common/common.ts#L55" } ], "type": { "type": "intrinsic", "name": "string" } } ], "groups": [ { "title": "Properties", "children": [852] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/types/common/common.ts", "line": 54, "character": 34, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/common/common.ts#L54" } ] } } }, { "id": 848, "name": "PostgrestMaybeSingleResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 30, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L30" } ], "typeParameters": [ { "id": 849, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "type": { "type": "reference", "target": 846, "typeArguments": [ { "type": "union", "types": [ { "type": "reference", "target": 849, "name": "T", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "literal", "value": null } ] } ], "name": "PostgrestSingleResponse", "package": "@supabase/postgrest-js" } }, { "id": 831, "name": "PostgrestResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 31, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L31" } ], "typeParameters": [ { "id": 832, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "type": { "type": "reference", "target": 846, "typeArguments": [ { "type": "array", "elementType": { "type": "reference", "target": 832, "name": "T", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } } ], "name": "PostgrestSingleResponse", "package": "@supabase/postgrest-js" } }, { "id": 846, "name": "PostgrestSingleResponse", "variant": "declaration", "kind": 2097152, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/types/types.ts", "line": 29, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/types/types.ts#L29" } ], "typeParameters": [ { "id": 847, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} } ], "type": { "type": "union", "types": [ { "type": "reference", "target": 839, "typeArguments": [ { "type": "reference", "target": 847, "name": "T", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "PostgrestResponseSuccess", "package": "@supabase/postgrest-js" }, { "type": "reference", "target": 833, "name": "PostgrestResponseFailure", "package": "@supabase/postgrest-js" } ] } }, { "id": 853, "name": "UnstableGetResult", "variant": "declaration", "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Main entry point for constructing the result type of a PostgREST query." } ] }, "sources": [ { "fileName": "packages/core/postgrest-js/src/select-query-parser/result.ts", "line": 38, "character": 12, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/select-query-parser/result.ts#L38" } ], "typeParameters": [ { "id": 854, "name": "Schema", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Database schema." } ] }, "type": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericSchema" }, "name": "GenericSchema", "package": "@supabase/postgrest-js" } }, { "id": 855, "name": "Row", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The type of a row in the current table." } ] }, "type": { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts", "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", "name": "string" }, { "type": "intrinsic", "name": "unknown" } ], "name": "Record", "package": "typescript" } }, { "id": 856, "name": "RelationName", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The name of the current table or view." } ] } }, { "id": 857, "name": "Relationships", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "Relationships of the current table." } ] } }, { "id": 858, "name": "Query", "variant": "typeParam", "kind": 131072, "flags": {}, "comment": { "summary": [ { "kind": "text", "text": "The select query string literal to parse." } ] }, "type": { "type": "intrinsic", "name": "string" } }, { "id": 859, "name": "ClientOptions", "variant": "typeParam", "kind": 131072, "flags": {}, "type": { "type": "reference", "target": 850, "name": "ClientServerOptions", "package": "@supabase/postgrest-js" } } ], "type": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/utils.ts", "qualifiedName": "IsAny" }, "typeArguments": [ { "type": "reference", "target": 854, "name": "Schema", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "IsAny", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "literal", "value": true }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/parser.ts", "qualifiedName": "ParseQuery" }, "typeArguments": [ { "type": "reference", "target": 858, "name": "Query", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ParseQuery", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "inferred", "name": "ParsedQuery" }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ParsedQuery" }, "name": "ParsedQuery", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/parser.ts", "qualifiedName": "Ast.Node" }, "name": "Ast.Node", "package": "@supabase/postgrest-js" } }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": 856, "name": "RelationName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "intrinsic", "name": "string" }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ProcessNodesWithoutSchema" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ParsedQuery" }, "name": "ParsedQuery", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ProcessNodesWithoutSchema", "package": "@supabase/postgrest-js" }, "falseType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ParsedQuery" }, "name": "ParsedQuery", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "falseType": { "type": "intrinsic", "name": "any" } }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "target": 857, "name": "Relationships", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "literal", "value": null }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/parser.ts", "qualifiedName": "ParseQuery" }, "typeArguments": [ { "type": "reference", "target": 858, "name": "Query", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ParseQuery", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "inferred", "name": "ParsedQuery" }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ParsedQuery" }, "name": "ParsedQuery", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/parser.ts", "qualifiedName": "Ast.Node" }, "name": "Ast.Node", "package": "@supabase/postgrest-js" } }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "RPCCallNodes" }, "typeArguments": [ { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ParsedQuery" }, "name": "ParsedQuery", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "conditional", "checkType": { "type": "reference", "target": 856, "name": "RelationName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "intrinsic", "name": "string" }, "trueType": { "type": "reference", "target": 856, "name": "RelationName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "falseType": { "type": "literal", "value": "rpc_call" } }, { "type": "reference", "target": 855, "name": "Row", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "RPCCallNodes", "package": "@supabase/postgrest-js" }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ParsedQuery" }, "name": "ParsedQuery", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "falseType": { "type": "reference", "target": 855, "name": "Row", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "falseType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/parser.ts", "qualifiedName": "ParseQuery" }, "typeArguments": [ { "type": "reference", "target": 858, "name": "Query", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ParseQuery", "package": "@supabase/postgrest-js" }, "extendsType": { "type": "inferred", "name": "ParsedQuery" }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ParsedQuery" }, "name": "ParsedQuery", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/parser.ts", "qualifiedName": "Ast.Node" }, "name": "Ast.Node", "package": "@supabase/postgrest-js" } }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": 856, "name": "RelationName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "intrinsic", "name": "string" }, "trueType": { "type": "conditional", "checkType": { "type": "reference", "target": 857, "name": "Relationships", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, "extendsType": { "type": "array", "elementType": { "type": "reference", "target": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "GenericRelationship" }, "name": "GenericRelationship", "package": "@supabase/postgrest-js" } }, "trueType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ProcessNodes" }, "typeArguments": [ { "type": "reference", "target": 859, "name": "ClientOptions", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 854, "name": "Schema", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 855, "name": "Row", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 856, "name": "RelationName", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": 857, "name": "Relationships", "package": "@supabase/postgrest-js", "refersToTypeParameter": true }, { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ParsedQuery" }, "name": "ParsedQuery", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } ], "name": "ProcessNodes", "package": "@supabase/postgrest-js" }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/utils.ts", "qualifiedName": "SelectQueryError" }, "typeArguments": [ { "type": "literal", "value": "Invalid Relationships cannot infer result type" } ], "name": "SelectQueryError", "package": "@supabase/postgrest-js" } }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/utils.ts", "qualifiedName": "SelectQueryError" }, "typeArguments": [ { "type": "literal", "value": "Invalid RelationName cannot infer result type" } ], "name": "SelectQueryError", "package": "@supabase/postgrest-js" } }, "falseType": { "type": "reference", "target": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ParsedQuery" }, "name": "ParsedQuery", "package": "@supabase/postgrest-js", "refersToTypeParameter": true } }, "falseType": { "type": "intrinsic", "name": "never" } } } } }, { "id": 1, "name": "default", "variant": "declaration", "kind": 32, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/index.ts", "line": 16, "character": 0, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/index.ts#L16" } ], "type": { "type": "reflection", "declaration": { "id": 2, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { "id": 7, "name": "PostgrestBuilder", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/index.ts", "line": 21, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/index.ts#L21" } ], "type": { "type": "query", "queryType": { "type": "reference", "target": 745, "name": "default", "package": "@supabase/postgrest-js" } } }, { "id": 3, "name": "PostgrestClient", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/index.ts", "line": 17, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/index.ts#L17" } ], "type": { "type": "query", "queryType": { "type": "reference", "target": 9, "name": "default", "package": "@supabase/postgrest-js" } } }, { "id": 8, "name": "PostgrestError", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/index.ts", "line": 22, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/index.ts#L22" } ], "type": { "type": "query", "queryType": { "type": "reference", "target": 819, "name": "default", "package": "@supabase/postgrest-js" } } }, { "id": 5, "name": "PostgrestFilterBuilder", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/index.ts", "line": 19, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/index.ts#L19" } ], "type": { "type": "query", "queryType": { "type": "reference", "target": 180, "name": "default", "package": "@supabase/postgrest-js" } } }, { "id": 4, "name": "PostgrestQueryBuilder", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/index.ts", "line": 18, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/index.ts#L18" } ], "type": { "type": "query", "queryType": { "type": "reference", "target": 78, "name": "default", "package": "@supabase/postgrest-js" } } }, { "id": 6, "name": "PostgrestTransformBuilder", "variant": "declaration", "kind": 1024, "flags": {}, "sources": [ { "fileName": "packages/core/postgrest-js/src/index.ts", "line": 20, "character": 2, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/index.ts#L20" } ], "type": { "type": "query", "queryType": { "type": "reference", "target": 584, "name": "default", "package": "@supabase/postgrest-js" } } } ], "groups": [ { "title": "Properties", "children": [7, 3, 8, 5, 4, 6] } ], "sources": [ { "fileName": "packages/core/postgrest-js/src/index.ts", "line": 16, "character": 15, "url": "https://github.com/supabase/supabase-js/blob/f26b924d3b21bcac1b2de68f16f9b2c611655432/packages/core/postgrest-js/src/index.ts#L16" } ] } } } ], "groups": [ { "title": "Classes", "children": [745, 9, 819, 180, 78, 584] }, { "title": "Interfaces", "children": [833, 839] }, { "title": "Type Aliases", "children": [850, 848, 831, 846, 853] }, { "title": "Variables", "children": [1] } ], "packageName": "@supabase/postgrest-js", "readme": [ { "kind": "text", "text": "
\n

\n \n \n \n \n \"Supabase\n \n \n\n

Supabase PostgREST JS SDK

\n\n

Isomorphic JavaScript SDK for PostgREST with an ORM-like interface.

\n\n

\n Guides\n ·\n Reference Docs\n ·\n TypeDoc\n

\n

\n\n
\n\n[![Build](https://github.com/supabase/supabase-js/workflows/CI/badge.svg)](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[![Package](https://img.shields.io/npm/v/@supabase/postgrest-js)](https://www.npmjs.com/package/@supabase/postgrest-js)\n[![License: MIT](https://img.shields.io/npm/l/@supabase/supabase-js)](#license)\n[![pkg.pr.new](https://pkg.pr.new/badge/supabase/postgrest-js)](https://pkg.pr.new/~/supabase/postgrest-js)\n\n
\n\n### Quick start\n\nInstall\n\n" }, { "kind": "code", "text": "```bash\nnpm install @supabase/postgrest-js\n```" }, { "kind": "text", "text": "\n\nUsage\n\n" }, { "kind": "code", "text": "```js\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst REST_URL = 'http://localhost:3000'\nconst postgrest = new PostgrestClient(REST_URL)\n```" }, { "kind": "text", "text": "\n\n- [select()](https://supabase.com/docs/reference/javascript/select)\n- [insert()](https://supabase.com/docs/reference/javascript/insert)\n- [update()](https://supabase.com/docs/reference/javascript/update)\n- [delete()](https://supabase.com/docs/reference/javascript/delete)\n\n#### Custom " }, { "kind": "code", "text": "`fetch`" }, { "kind": "text", "text": " implementation\n\n" }, { "kind": "code", "text": "`postgrest-js`" }, { "kind": "text", "text": " uses the [" }, { "kind": "code", "text": "`cross-fetch`" }, { "kind": "text", "text": "](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative " }, { "kind": "code", "text": "`fetch`" }, { "kind": "text", "text": " implementation can be provided as an option. This is most useful in environments where " }, { "kind": "code", "text": "`cross-fetch`" }, { "kind": "text", "text": " is not compatible, for instance Cloudflare Workers:\n\n" }, { "kind": "code", "text": "```js\nimport { PostgrestClient } from '@supabase/postgrest-js'\n\nconst REST_URL = 'http://localhost:3000'\nconst postgrest = new PostgrestClient(REST_URL, {\n fetch: (...args) => fetch(...args),\n})\n```" }, { "kind": "text", "text": "\n\n## Development\n\nThis package is part of the [Supabase JavaScript monorepo](https://github.com/supabase/supabase-js). To work on this package:\n\n### Building\n\n" }, { "kind": "code", "text": "```bash\n# Build (from monorepo root)\nnpx nx build postgrest-js\n\n# Build with watch mode for development\nnpx nx build:watch postgrest-js\n\n# TypeScript type checking\nnpx nx type-check postgrest-js\n\n# Generate documentation\nnpx nx docs postgrest-js\n```" }, { "kind": "text", "text": "\n\n### Testing\n\n**Supabase CLI Required!** The " }, { "kind": "code", "text": "`postgrest-js`" }, { "kind": "text", "text": " tests use the [Supabase CLI](https://supabase.com/docs/guides/local-development/cli/getting-started) to run a local PostgreSQL database and PostgREST server.\n\n#### Quick Start\n\n" }, { "kind": "code", "text": "```bash\n# Run all tests (from monorepo root)\nnpx nx test:ci:postgrest postgrest-js\n```" }, { "kind": "text", "text": "\n\nThis single command automatically:\n\n1. Stops any existing Supabase CLI containers\n2. Starts PostgreSQL database and PostgREST server via Supabase CLI\n3. Resets and seeds the database\n4. Runs all Jest unit tests with coverage\n5. Cleans up containers\n\n#### Individual Test Commands\n\n" }, { "kind": "code", "text": "```bash\n# Run Jest tests with coverage (requires infrastructure running)\nnpx nx test:run postgrest-js\n\n# Run type tests with tstyche\nnpx nx test:types postgrest-js\n\n# Run smoke tests (CommonJS and ESM imports)\nnpx nx test:smoke postgrest-js\n\n# Format code\nnpx nx format postgrest-js\n\n# Check formatting\nnpx nx format:check postgrest-js\n```" }, { "kind": "text", "text": "\n\n#### Test Infrastructure\n\nThe tests use Supabase CLI to spin up:\n\n- **PostgreSQL** - Database with test schema and seed data (port 54322)\n- **PostgREST** - REST API server that the client connects to (port 54321)\n\n" }, { "kind": "code", "text": "```bash\n# Manually manage test infrastructure (from monorepo root)\nnpx nx test:infra postgrest-js # Start containers\nnpx nx test:clean-pre postgrest-js # Stop and remove containers\n```" }, { "kind": "text", "text": "\n\nOr directly via Supabase CLI:\n\n" }, { "kind": "code", "text": "```bash\ncd packages/core/postgrest-js\nnpx supabase --workdir ./test start # Start all services\nnpx supabase --workdir ./test db reset # Reset and seed database\nnpx supabase --workdir ./test stop # Stop all services\n```" }, { "kind": "text", "text": "\n\n#### Regenerating TypeScript Types\n\nWhen the database schema changes, regenerate TypeScript types from the actual database:\n\n" }, { "kind": "code", "text": "```bash\n# From the monorepo root\nnpm run codegen:postgrest\n```" }, { "kind": "text", "text": "\n\nThis command automatically:\n\n1. Cleans up any existing Supabase containers\n2. Starts Supabase (PostgreSQL, PostgREST, and all services)\n3. Generates TypeScript types from the database schema\n4. Post-processes the generated types (updates JSON type definitions)\n5. Formats the generated file with Prettier\n6. Cleans up Supabase containers\n\nThe generated types are written to " }, { "kind": "code", "text": "`test/types.generated.ts`" }, { "kind": "text", "text": ".\n\n#### Test Types Explained\n\n- **Unit Tests** - Jest tests covering all client functionality (" }, { "kind": "code", "text": "`npx nx test:run postgrest-js`" }, { "kind": "text", "text": ")\n- **Type Tests** - Validates TypeScript types using tstyche (" }, { "kind": "code", "text": "`npx nx test:types postgrest-js`" }, { "kind": "text", "text": ")\n- **Smoke Tests** - Basic import/require tests for CommonJS and ESM (" }, { "kind": "code", "text": "`npx nx test:smoke postgrest-js`" }, { "kind": "text", "text": ")\n\n#### Prerequisites\n\n- **Supabase CLI** must be installed ([instructions](https://supabase.com/docs/guides/local-development/cli/getting-started)) or can be used through " }, { "kind": "code", "text": "`npx`" }, { "kind": "text", "text": " (" }, { "kind": "code", "text": "`npx supabase`" }, { "kind": "text", "text": ")\n- **Docker** must be installed and running (Supabase CLI uses Docker under the hood)\n- **Port 54321** - PostgREST API\n- **Port 54322** - PostgreSQL database\n- **Port 54323** - Supabase Studio (used for type generation)\n\n#### PostgREST v12 Backward Compatibility Tests\n\nWe maintain backward compatibility tests for PostgREST v12 (the current Supabase CLI uses v14+). These tests ensure the SDK works correctly for users still running older PostgREST versions.\n\n" }, { "kind": "code", "text": "```bash\n# Run v12 compatibility tests (requires Docker)\nnpx nx test:ci:v12 postgrest-js\n```" }, { "kind": "text", "text": "\n\nThis command:\n\n1. Starts PostgREST v12 + PostgreSQL in Docker (ports 3012/5433)\n2. Runs runtime tests that verify v12-specific behavior\n3. Cleans up containers\n\n**Type-only tests** for v12 compatibility also run as part of the regular type tests:\n\n" }, { "kind": "code", "text": "```bash\nnpx nx test:types postgrest-js # Includes v12-compat.test-d.ts\n```" }, { "kind": "text", "text": "\n\n**Note:** These v12 tests will be removed when v3 ships (sometime in 2026).\n\n### Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](" }, { "kind": "relative-link", "text": "../../../CONTRIBUTING.md", "target": 2 }, { "kind": "text", "text": ") for details on how to get started.\n\nFor major changes or if you're unsure about something, please open an issue first to discuss your proposed changes.\n\n## License\n\nThis repo is licensed under MIT License." } ], "symbolIdMap": { "0": { "sourceFileName": "src/index.ts", "qualifiedName": "" }, "1": { "sourceFileName": "src/index.ts", "qualifiedName": "default" }, "2": { "sourceFileName": "src/index.ts", "qualifiedName": "__object" }, "3": { "sourceFileName": "src/index.ts", "qualifiedName": "__object.PostgrestClient" }, "4": { "sourceFileName": "src/index.ts", "qualifiedName": "__object.PostgrestQueryBuilder" }, "5": { "sourceFileName": "src/index.ts", "qualifiedName": "__object.PostgrestFilterBuilder" }, "6": { "sourceFileName": "src/index.ts", "qualifiedName": "__object.PostgrestTransformBuilder" }, "7": { "sourceFileName": "src/index.ts", "qualifiedName": "__object.PostgrestBuilder" }, "8": { "sourceFileName": "src/index.ts", "qualifiedName": "__object.PostgrestError" }, "9": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default" }, "10": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.__constructor" }, "11": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default" }, "12": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.Database" }, "13": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.ClientOptions" }, "14": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type" }, "15": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type.__InternalSupabase" }, "16": { "sourceFileName": "", "qualifiedName": "__type" }, "17": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.SchemaName" }, "18": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.Schema" }, "19": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "url" }, "20": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__1" }, "21": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type" }, "22": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type.headers" }, "23": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type.schema" }, "24": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type.fetch" }, "25": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "26": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "27": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "28": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "29": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "30": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "31": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "32": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type.timeout" }, "33": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type.urlLengthLimit" }, "34": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.url" }, "35": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.headers" }, "36": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.schemaName" }, "37": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.fetch" }, "38": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "39": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "40": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "41": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "42": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "43": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "44": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "45": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.urlLengthLimit" }, "46": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.from" }, "47": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.from" }, "48": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "TableName" }, "49": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "Table" }, "50": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "relation" }, "51": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.from" }, "52": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "ViewName" }, "53": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "View" }, "54": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "relation" }, "55": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.schema" }, "56": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.schema" }, "57": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "DynamicSchema" }, "58": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "schema" }, "59": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.rpc" }, "60": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.rpc" }, "61": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "FnName" }, "62": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "Args" }, "63": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "FilterBuilder" }, "64": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "fn" }, "65": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "args" }, "66": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__2" }, "67": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type" }, "68": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type.head" }, "69": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type.get" }, "70": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type.count" }, "71": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.Database" }, "72": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.ClientOptions" }, "73": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type" }, "74": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type.__InternalSupabase" }, "75": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "__type" }, "76": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.SchemaName" }, "77": { "sourceFileName": "src/PostgrestClient.ts", "qualifiedName": "default.Schema" }, "78": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default" }, "79": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.__constructor" }, "80": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default" }, "81": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.ClientOptions" }, "82": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.Schema" }, "83": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.Relation" }, "84": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.RelationName" }, "85": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.Relationships" }, "86": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type" }, "87": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.Relationships" }, "88": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "url" }, "89": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__1" }, "90": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type" }, "91": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.headers" }, "92": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.schema" }, "93": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.fetch" }, "94": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "95": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "96": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "97": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "98": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "99": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "100": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "101": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.urlLengthLimit" }, "102": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.url" }, "103": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.headers" }, "104": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.schema" }, "105": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.signal" }, "106": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.fetch" }, "107": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "108": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "109": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "110": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "111": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "112": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "113": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "114": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.urlLengthLimit" }, "120": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.select" }, "121": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.select" }, "122": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "Query" }, "123": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "ResultOne" }, "124": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "columns" }, "125": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "options" }, "126": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type" }, "127": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.head" }, "128": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.count" }, "129": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.insert" }, "130": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.insert" }, "131": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "Row" }, "132": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "values" }, "133": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "options" }, "134": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type" }, "135": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.count" }, "136": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.insert" }, "137": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "Row" }, "138": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "values" }, "139": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "options" }, "140": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type" }, "141": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.count" }, "142": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.defaultToNull" }, "143": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.upsert" }, "144": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.upsert" }, "145": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "Row" }, "146": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "values" }, "147": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "options" }, "148": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type" }, "149": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.onConflict" }, "150": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.ignoreDuplicates" }, "151": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.count" }, "152": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.upsert" }, "153": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "Row" }, "154": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "values" }, "155": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "options" }, "156": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type" }, "157": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.onConflict" }, "158": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.ignoreDuplicates" }, "159": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.count" }, "160": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.defaultToNull" }, "161": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.update" }, "162": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.update" }, "163": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "Row" }, "164": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "values" }, "165": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__1" }, "166": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type" }, "167": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.count" }, "168": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.delete" }, "169": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.delete" }, "170": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__0" }, "171": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type" }, "172": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.count" }, "173": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.ClientOptions" }, "174": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.Schema" }, "175": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.Relation" }, "176": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.RelationName" }, "177": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "default.Relationships" }, "178": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type" }, "179": { "sourceFileName": "src/PostgrestQueryBuilder.ts", "qualifiedName": "__type.Relationships" }, "180": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default" }, "181": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.__constructor" }, "182": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default" }, "183": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.ClientOptions" }, "184": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.Schema" }, "185": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.Row" }, "186": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.Result" }, "187": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.RelationName" }, "188": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.Relationships" }, "189": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.Method" }, "190": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "builder" }, "191": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "192": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.method" }, "193": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.url" }, "194": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.headers" }, "195": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.schema" }, "196": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.body" }, "197": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.shouldThrowOnError" }, "198": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.signal" }, "199": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.fetch" }, "200": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "201": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "202": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "203": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "204": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "205": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "206": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "207": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.isMaybeSingle" }, "208": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.urlLengthLimit" }, "209": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.eq" }, "210": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.eq" }, "211": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "212": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "213": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "214": { "sourceFileName": "", "qualifiedName": "__type" }, "215": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.neq" }, "216": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.neq" }, "217": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "218": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "219": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "220": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.gt" }, "221": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.gt" }, "222": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "223": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "224": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "225": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.gt" }, "226": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "227": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "228": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.gte" }, "229": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.gte" }, "230": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "231": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "232": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "233": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.gte" }, "234": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "235": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "236": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.lt" }, "237": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.lt" }, "238": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "239": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "240": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "241": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.lt" }, "242": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "243": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "244": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.lte" }, "245": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.lte" }, "246": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "247": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "248": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "249": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.lte" }, "250": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "251": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "252": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.like" }, "253": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.like" }, "254": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "255": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "256": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "pattern" }, "257": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.like" }, "258": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "259": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "pattern" }, "260": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.likeAllOf" }, "261": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.likeAllOf" }, "262": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "263": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "264": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "patterns" }, "265": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.likeAllOf" }, "266": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "267": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "patterns" }, "268": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.likeAnyOf" }, "269": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.likeAnyOf" }, "270": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "271": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "272": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "patterns" }, "273": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.likeAnyOf" }, "274": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "275": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "patterns" }, "276": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.ilike" }, "277": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.ilike" }, "278": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "279": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "280": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "pattern" }, "281": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.ilike" }, "282": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "283": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "pattern" }, "284": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.ilikeAllOf" }, "285": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.ilikeAllOf" }, "286": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "287": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "288": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "patterns" }, "289": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.ilikeAllOf" }, "290": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "291": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "patterns" }, "292": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.ilikeAnyOf" }, "293": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.ilikeAnyOf" }, "294": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "295": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "296": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "patterns" }, "297": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.ilikeAnyOf" }, "298": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "299": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "patterns" }, "300": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.regexMatch" }, "301": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.regexMatch" }, "302": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "303": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "304": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "pattern" }, "305": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.regexMatch" }, "306": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "307": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "pattern" }, "308": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.regexIMatch" }, "309": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.regexIMatch" }, "310": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "311": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "312": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "pattern" }, "313": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.regexIMatch" }, "314": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "315": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "pattern" }, "316": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.is" }, "317": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.is" }, "318": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "319": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "320": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "321": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.is" }, "322": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "323": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "324": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.isDistinct" }, "325": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.isDistinct" }, "326": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "327": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "328": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "329": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.in" }, "330": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.in" }, "331": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "332": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "333": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "values" }, "334": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.notIn" }, "335": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.notIn" }, "336": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "337": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "338": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "values" }, "339": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.contains" }, "340": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.contains" }, "341": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "342": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "343": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "344": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.contains" }, "345": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "346": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "347": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.containedBy" }, "348": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.containedBy" }, "349": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "350": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "351": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "352": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.containedBy" }, "353": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "354": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "355": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeGt" }, "356": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeGt" }, "357": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "358": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "359": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "range" }, "360": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeGt" }, "361": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "362": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "range" }, "363": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeGte" }, "364": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeGte" }, "365": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "366": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "367": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "range" }, "368": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeGte" }, "369": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "370": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "range" }, "371": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeLt" }, "372": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeLt" }, "373": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "374": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "375": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "range" }, "376": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeLt" }, "377": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "378": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "range" }, "379": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeLte" }, "380": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeLte" }, "381": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "382": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "383": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "range" }, "384": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeLte" }, "385": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "386": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "range" }, "387": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeAdjacent" }, "388": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeAdjacent" }, "389": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "390": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "391": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "range" }, "392": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.rangeAdjacent" }, "393": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "394": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "range" }, "395": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.overlaps" }, "396": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.overlaps" }, "397": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "398": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "399": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "400": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.overlaps" }, "401": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "402": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "403": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.textSearch" }, "404": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.textSearch" }, "405": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "406": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "407": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "query" }, "408": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "options" }, "409": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "__type" }, "410": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "__type.config" }, "411": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "__type.type" }, "412": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.textSearch" }, "413": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "414": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "query" }, "415": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "options" }, "416": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "__type" }, "417": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "__type.config" }, "418": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "__type.type" }, "419": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.match" }, "420": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.match" }, "421": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "422": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "query" }, "423": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.match" }, "424": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "query" }, "425": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.not" }, "426": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.not" }, "427": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "428": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "429": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "operator" }, "430": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "431": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.not" }, "432": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "433": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "operator" }, "434": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "435": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.or" }, "436": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.or" }, "437": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "filters" }, "438": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "__1" }, "439": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "__type" }, "440": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "__type.foreignTable" }, "441": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "__type.referencedTable" }, "442": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.filter" }, "443": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.filter" }, "444": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "ColumnName" }, "445": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "446": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "operator" }, "447": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "448": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.filter" }, "449": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "column" }, "450": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "operator" }, "451": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "value" }, "452": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.select" }, "453": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.select" }, "454": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "Query" }, "455": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "NewResultOne" }, "456": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "columns" }, "457": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.order" }, "458": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.order" }, "459": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ColumnName" }, "460": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "column" }, "461": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "options" }, "462": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "463": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.ascending" }, "464": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.nullsFirst" }, "465": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.referencedTable" }, "466": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.order" }, "467": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "column" }, "468": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "options" }, "469": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "470": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.ascending" }, "471": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.nullsFirst" }, "472": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.referencedTable" }, "473": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.order" }, "474": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ColumnName" }, "475": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "column" }, "476": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "options" }, "477": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "478": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.ascending" }, "479": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.nullsFirst" }, "480": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.foreignTable" }, "481": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.order" }, "482": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "column" }, "483": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "options" }, "484": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "485": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.ascending" }, "486": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.nullsFirst" }, "487": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.foreignTable" }, "488": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.limit" }, "489": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.limit" }, "490": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "count" }, "491": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__1" }, "492": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "493": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.foreignTable" }, "494": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.referencedTable" }, "495": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.range" }, "496": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.range" }, "497": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "from" }, "498": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "to" }, "499": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__2" }, "500": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "501": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.foreignTable" }, "502": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.referencedTable" }, "503": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.abortSignal" }, "504": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.abortSignal" }, "505": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "signal" }, "506": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.single" }, "507": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.single" }, "508": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "509": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.maybeSingle" }, "510": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.maybeSingle" }, "511": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "512": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.csv" }, "513": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.csv" }, "514": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.geojson" }, "515": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.geojson" }, "516": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.explain" }, "517": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.explain" }, "518": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__0" }, "519": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "520": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.analyze" }, "521": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.verbose" }, "522": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.settings" }, "523": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.buffers" }, "524": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.wal" }, "525": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.format" }, "526": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.rollback" }, "527": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.rollback" }, "528": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.returns" }, "529": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.returns" }, "530": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "NewResult" }, "531": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.maxAffected" }, "532": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.maxAffected" }, "533": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "value" }, "534": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.method" }, "535": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.url" }, "536": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.headers" }, "537": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.schema" }, "538": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.body" }, "539": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.shouldThrowOnError" }, "540": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.signal" }, "541": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.fetch" }, "542": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "543": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "544": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "545": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "546": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "547": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "548": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "549": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.isMaybeSingle" }, "550": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.urlLengthLimit" }, "551": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.throwOnError" }, "552": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.throwOnError" }, "553": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.setHeader" }, "554": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.setHeader" }, "555": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "name" }, "556": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "value" }, "557": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.then" }, "558": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.then" }, "559": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "TResult1" }, "560": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "TResult2" }, "561": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "onfulfilled" }, "562": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "563": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "564": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "value" }, "565": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "onrejected" }, "566": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "567": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "568": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "reason" }, "569": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.overrideTypes" }, "570": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.overrideTypes" }, "571": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "NewResult" }, "572": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "Options" }, "573": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "574": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.merge" }, "575": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "576": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.merge" }, "577": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.ClientOptions" }, "578": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.Schema" }, "579": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.Row" }, "580": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.Result" }, "581": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.RelationName" }, "582": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.Relationships" }, "583": { "sourceFileName": "src/PostgrestFilterBuilder.ts", "qualifiedName": "default.Method" }, "584": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default" }, "585": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.__constructor" }, "586": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default" }, "587": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.ClientOptions" }, "588": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.Schema" }, "589": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.Row" }, "590": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.Result" }, "591": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.RelationName" }, "592": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.Relationships" }, "593": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.Method" }, "594": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "builder" }, "595": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "596": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.method" }, "597": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.url" }, "598": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.headers" }, "599": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.schema" }, "600": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.body" }, "601": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.shouldThrowOnError" }, "602": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.signal" }, "603": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.fetch" }, "604": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "605": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "606": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "607": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "608": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "609": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "610": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "611": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.isMaybeSingle" }, "612": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.urlLengthLimit" }, "613": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.select" }, "614": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.select" }, "615": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "Query" }, "616": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "NewResultOne" }, "617": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "columns" }, "618": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.order" }, "619": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.order" }, "620": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ColumnName" }, "621": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "column" }, "622": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "options" }, "623": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "624": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.ascending" }, "625": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.nullsFirst" }, "626": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.referencedTable" }, "627": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.order" }, "628": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "column" }, "629": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "options" }, "630": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "631": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.ascending" }, "632": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.nullsFirst" }, "633": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.referencedTable" }, "634": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.order" }, "635": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ColumnName" }, "636": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "column" }, "637": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "options" }, "638": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "639": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.ascending" }, "640": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.nullsFirst" }, "641": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.foreignTable" }, "642": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.order" }, "643": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "column" }, "644": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "options" }, "645": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "646": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.ascending" }, "647": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.nullsFirst" }, "648": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.foreignTable" }, "649": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.limit" }, "650": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.limit" }, "651": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "count" }, "652": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__1" }, "653": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "654": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.foreignTable" }, "655": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.referencedTable" }, "656": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.range" }, "657": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.range" }, "658": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "from" }, "659": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "to" }, "660": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__2" }, "661": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "662": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.foreignTable" }, "663": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.referencedTable" }, "664": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.abortSignal" }, "665": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.abortSignal" }, "666": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "signal" }, "667": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.single" }, "668": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.single" }, "669": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "670": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.maybeSingle" }, "671": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.maybeSingle" }, "672": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "ResultOne" }, "673": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.csv" }, "674": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.csv" }, "675": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.geojson" }, "676": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.geojson" }, "677": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.explain" }, "678": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.explain" }, "679": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__0" }, "680": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type" }, "681": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.analyze" }, "682": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.verbose" }, "683": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.settings" }, "684": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.buffers" }, "685": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.wal" }, "686": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "__type.format" }, "687": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.rollback" }, "688": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.rollback" }, "689": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.returns" }, "690": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.returns" }, "691": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "NewResult" }, "692": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.maxAffected" }, "693": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.maxAffected" }, "694": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "value" }, "695": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.method" }, "696": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.url" }, "697": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.headers" }, "698": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.schema" }, "699": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.body" }, "700": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.shouldThrowOnError" }, "701": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.signal" }, "702": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.fetch" }, "703": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "704": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "705": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "706": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "707": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "708": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "709": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "710": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.isMaybeSingle" }, "711": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.urlLengthLimit" }, "712": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.throwOnError" }, "713": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.throwOnError" }, "714": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.setHeader" }, "715": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.setHeader" }, "716": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "name" }, "717": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "value" }, "718": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.then" }, "719": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.then" }, "720": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "TResult1" }, "721": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "TResult2" }, "722": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "onfulfilled" }, "723": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "724": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "725": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "value" }, "726": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "onrejected" }, "727": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "728": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "729": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "reason" }, "730": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.overrideTypes" }, "731": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.overrideTypes" }, "732": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "NewResult" }, "733": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "Options" }, "734": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "735": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.merge" }, "736": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "737": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.merge" }, "738": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.ClientOptions" }, "739": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.Schema" }, "740": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.Row" }, "741": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.Result" }, "742": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.RelationName" }, "743": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.Relationships" }, "744": { "sourceFileName": "src/PostgrestTransformBuilder.ts", "qualifiedName": "default.Method" }, "745": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default" }, "746": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.__constructor" }, "747": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default" }, "748": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.ClientOptions" }, "749": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.Result" }, "750": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.ThrowOnError" }, "751": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "builder" }, "752": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "753": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.method" }, "754": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.url" }, "755": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.headers" }, "756": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.schema" }, "757": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.body" }, "758": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.shouldThrowOnError" }, "759": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.signal" }, "760": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.fetch" }, "761": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "762": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "763": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "764": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "765": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "766": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "767": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "768": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.isMaybeSingle" }, "769": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.urlLengthLimit" }, "770": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.method" }, "771": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.url" }, "772": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.headers" }, "773": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.schema" }, "774": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.body" }, "775": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.shouldThrowOnError" }, "776": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.signal" }, "777": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.fetch" }, "778": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "779": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "fetch" }, "780": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "input" }, "781": { "sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts", "qualifiedName": "init" }, "782": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "fetch" }, "783": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "input" }, "784": { "sourceFileName": "../../../node_modules/@types/node/globals.d.ts", "qualifiedName": "init" }, "785": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.isMaybeSingle" }, "786": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.urlLengthLimit" }, "787": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.throwOnError" }, "788": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.throwOnError" }, "789": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.setHeader" }, "790": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.setHeader" }, "791": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "name" }, "792": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "value" }, "793": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.then" }, "794": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.then" }, "795": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "TResult1" }, "796": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "TResult2" }, "797": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "onfulfilled" }, "798": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "799": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "800": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "value" }, "801": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "onrejected" }, "802": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "803": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "804": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "reason" }, "805": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.returns" }, "806": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.returns" }, "807": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "NewResult" }, "808": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.overrideTypes" }, "809": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.overrideTypes" }, "810": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "NewResult" }, "811": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "Options" }, "812": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "813": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.merge" }, "814": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type" }, "815": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "__type.merge" }, "816": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.ClientOptions" }, "817": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.Result" }, "818": { "sourceFileName": "src/PostgrestBuilder.ts", "qualifiedName": "default.ThrowOnError" }, "819": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "default" }, "820": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "default.__constructor" }, "821": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "default" }, "822": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "context" }, "823": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "__type" }, "824": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "__type.message" }, "825": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "__type.details" }, "826": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "__type.hint" }, "827": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "__type.code" }, "828": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "default.details" }, "829": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "default.hint" }, "830": { "sourceFileName": "src/PostgrestError.ts", "qualifiedName": "default.code" }, "831": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponse" }, "832": { "sourceFileName": "src/types/types.ts", "qualifiedName": "T" }, "833": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseFailure" }, "834": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseFailure.error" }, "835": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseFailure.data" }, "836": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseFailure.count" }, "837": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseBase.status" }, "838": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseBase.statusText" }, "839": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseSuccess" }, "840": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseSuccess.error" }, "841": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseSuccess.data" }, "842": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseSuccess.count" }, "843": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseBase.status" }, "844": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseBase.statusText" }, "845": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestResponseSuccess.T" }, "846": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestSingleResponse" }, "847": { "sourceFileName": "src/types/types.ts", "qualifiedName": "T" }, "848": { "sourceFileName": "src/types/types.ts", "qualifiedName": "PostgrestMaybeSingleResponse" }, "849": { "sourceFileName": "src/types/types.ts", "qualifiedName": "T" }, "850": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "ClientServerOptions" }, "851": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "__type" }, "852": { "sourceFileName": "src/types/common/common.ts", "qualifiedName": "__type.PostgrestVersion" }, "853": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "GetResult" }, "854": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "Schema" }, "855": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "Row" }, "856": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "RelationName" }, "857": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "Relationships" }, "858": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "Query" }, "859": { "sourceFileName": "src/select-query-parser/result.ts", "qualifiedName": "ClientOptions" } }, "files": { "entries": { "1": "src/index.ts", "2": "../../../CONTRIBUTING.md" }, "reflections": { "1": 0 } } }