mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 09:25:06 +03:00
supabase-supabase-autofixer[bot]andsupabase-releaser[bot]
0309fcccf0
Updates JS sdk documentation following stable release.
Ran `make` in apps/docs/spec to regenerate tsdoc files.
**Details:**
- **Version:** `2.106.0`
- **Source:** `supabase-js-stable-release`
- **Changes:** Regenerated tsdoc files from latest spec files
🤖 Auto-generated from @supabase/supabase-js stable release.
Co-authored-by: supabase-releaser[bot] <223506987+supabase-releaser[bot]@users.noreply.github.com>
39240 lines
1.4 MiB
Plaintext
39240 lines
1.4 MiB
Plaintext
{
|
|
"id": 0,
|
|
"name": "@supabase/postgrest-js",
|
|
"variant": "project",
|
|
"kind": 1,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 774,
|
|
"name": "PostgrestBuilder",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {
|
|
"isAbstract": true
|
|
},
|
|
"children": [
|
|
{
|
|
"id": 775,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 115,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 776,
|
|
"name": "PostgrestBuilder",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a builder configured for a specific PostgREST request."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@example",
|
|
"name": "Using supabase-js (recommended)",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Standalone import for bundle-sensitive environments",
|
|
"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: 'your-publishable-key' }) }\n)\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 115,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 777,
|
|
"name": "ClientOptions",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 908,
|
|
"name": "ClientServerOptions",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 778,
|
|
"name": "Result",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
},
|
|
{
|
|
"id": 779,
|
|
"name": "ThrowOnError",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"default": {
|
|
"type": "literal",
|
|
"value": false
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 780,
|
|
"name": "builder",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 781,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 786,
|
|
"name": "body",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 120,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 789,
|
|
"name": "fetch",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 123,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 790,
|
|
"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": 791,
|
|
"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": 792,
|
|
"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": 793,
|
|
"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": 794,
|
|
"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": 795,
|
|
"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": 796,
|
|
"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": 784,
|
|
"name": "headers",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 118,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "HeadersInit"
|
|
},
|
|
"name": "HeadersInit",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 797,
|
|
"name": "isMaybeSingle",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 124,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 782,
|
|
"name": "method",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 116,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116"
|
|
}
|
|
],
|
|
"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": 800,
|
|
"name": "retry",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 128,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L128"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 785,
|
|
"name": "schema",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 119,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 798,
|
|
"name": "shouldStripNulls",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 125,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L125"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 787,
|
|
"name": "shouldThrowOnError",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 121,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 788,
|
|
"name": "signal",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 122,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "AbortSignal"
|
|
},
|
|
"name": "AbortSignal",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 783,
|
|
"name": "url",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 117,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 799,
|
|
"name": "urlLengthLimit",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 126,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [786, 789, 784, 797, 782, 800, 785, 798, 787, 788, 783, 799]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 115,
|
|
"character": 23,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 777,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 779,
|
|
"name": "ThrowOnError",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ThrowOnError",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 805,
|
|
"name": "body",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 81,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 808,
|
|
"name": "fetch",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 84,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 809,
|
|
"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": 810,
|
|
"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": 811,
|
|
"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": 812,
|
|
"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": 813,
|
|
"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": 814,
|
|
"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": 815,
|
|
"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": 803,
|
|
"name": "headers",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 79,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Headers"
|
|
},
|
|
"name": "Headers",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 816,
|
|
"name": "isMaybeSingle",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 85,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 801,
|
|
"name": "method",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 77,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77"
|
|
}
|
|
],
|
|
"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": 819,
|
|
"name": "retryEnabled",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 90,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L90"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "true"
|
|
},
|
|
{
|
|
"id": 804,
|
|
"name": "schema",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 80,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 817,
|
|
"name": "shouldStripNulls",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 86,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L86"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 806,
|
|
"name": "shouldThrowOnError",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 82,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 807,
|
|
"name": "signal",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 83,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "AbortSignal"
|
|
},
|
|
"name": "AbortSignal",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 802,
|
|
"name": "url",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 78,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 818,
|
|
"name": "urlLengthLimit",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 87,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L87"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 856,
|
|
"name": "overrideTypes",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 664,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L664"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 857,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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<Array<MyType>, { 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<MyType, { merge: false }>()\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<Array<{ status: \"A\" | \"B\" }>>()\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@exampleResponse",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Partial Override type of successful response\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nlet x: typeof data // Array<CountryRowProperties & { status: \"A\" | \"B\" }>\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": "Merge vs replace existing types",
|
|
"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": 664,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L664"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 858,
|
|
"name": "NewResult",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The new type to cast the response data to"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 859,
|
|
"name": "Options",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Optional type configuration (defaults to { merge: true })"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 860,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 861,
|
|
"name": "merge",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 22,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [861]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 20,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"default": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 862,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 863,
|
|
"name": "merge",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 44,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": true
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [863]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 42,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 777,
|
|
"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": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 591,
|
|
"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": 778,
|
|
"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": 591,
|
|
"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": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "NonNullable",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 592,
|
|
"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": 591,
|
|
"name": "NewResult",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 592,
|
|
"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": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 591,
|
|
"name": "NewResult",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "CheckMatchingArrayTypes",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 779,
|
|
"name": "ThrowOnError",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ThrowOnError",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 828,
|
|
"name": "retry",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 251,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L251"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 829,
|
|
"name": "retry",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts."
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 251,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L251"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 830,
|
|
"name": "enabled",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Whether to enable retries for this request"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 853,
|
|
"name": "returns",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 557,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L557"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 854,
|
|
"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<yourType, { merge: false }>() 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": 557,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L557"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 855,
|
|
"name": "NewResult",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The new result type to override with"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 777,
|
|
"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": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 855,
|
|
"name": "NewResult",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "CheckMatchingArrayTypes",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 779,
|
|
"name": "ThrowOnError",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ThrowOnError",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 824,
|
|
"name": "setHeader",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 225,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L225"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 825,
|
|
"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": 225,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L225"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 826,
|
|
"name": "name",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 827,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 822,
|
|
"name": "stripNulls",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 212,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L212"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 823,
|
|
"name": "stripNulls",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Strip null values from the response data. Properties with "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`null`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n"
|
|
},
|
|
{
|
|
"kind": "inline-tag",
|
|
"tag": "@link",
|
|
"text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls",
|
|
"target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls"
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "With `select()`",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\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, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\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 \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 212,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L212"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 831,
|
|
"name": "then",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 256,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L256"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 832,
|
|
"name": "then",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Attaches callbacks for the resolution and/or rejection of the Promise."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "A Promise for the completion of which ever callback is executed."
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 256,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L256"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 833,
|
|
"name": "TResult1",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 779,
|
|
"name": "ThrowOnError",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ThrowOnError",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "literal",
|
|
"value": true
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"target": 896,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestResponseSuccess",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
"falseType": {
|
|
"type": "reference",
|
|
"target": 904,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 834,
|
|
"name": "TResult2",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 835,
|
|
"name": "onfulfilled",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The callback to execute when the Promise is resolved."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 836,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 263,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L263"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 837,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 263,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L263"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 838,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 779,
|
|
"name": "ThrowOnError",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ThrowOnError",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "literal",
|
|
"value": true
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"target": 896,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestResponseSuccess",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
"falseType": {
|
|
"type": "reference",
|
|
"target": 904,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 579,
|
|
"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": 579,
|
|
"name": "TResult1",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 839,
|
|
"name": "onrejected",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The callback to execute when the Promise is rejected."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 840,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 270,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L270"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 841,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 270,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L270"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 842,
|
|
"name": "reason",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 580,
|
|
"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": 580,
|
|
"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": 579,
|
|
"name": "TResult1",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 580,
|
|
"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": 820,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 157,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L157"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 821,
|
|
"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": 157,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L157"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 777,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 779,
|
|
"name": "ThrowOnError",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ThrowOnError",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 777,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 778,
|
|
"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": [775]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [805, 808, 803, 816, 801, 819, 804, 817, 806, 807, 802, 818]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [856, 828, 853, 824, 822, 831, 820]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Database",
|
|
"children": [775, 856, 853, 824, 822, 820]
|
|
},
|
|
{
|
|
"title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.",
|
|
"children": [828]
|
|
},
|
|
{
|
|
"title": "Other",
|
|
"children": [805, 808, 803, 816, 801, 819, 804, 817, 806, 807, 802, 818, 831]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 68,
|
|
"character": 30,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L68"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 864,
|
|
"name": "ClientOptions",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 908,
|
|
"name": "ClientServerOptions",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 865,
|
|
"name": "Result",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
},
|
|
{
|
|
"id": 866,
|
|
"name": "ThrowOnError",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"default": {
|
|
"type": "literal",
|
|
"value": false
|
|
}
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"target": 604,
|
|
"name": "PostgrestTransformBuilder"
|
|
}
|
|
],
|
|
"implementedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.es5.d.ts",
|
|
"qualifiedName": "PromiseLike"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 779,
|
|
"name": "ThrowOnError",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ThrowOnError",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "literal",
|
|
"value": true
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"target": 896,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 778,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestResponseSuccess",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
"falseType": {
|
|
"type": "reference",
|
|
"target": 904,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 778,
|
|
"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": 86,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L86"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 11,
|
|
"name": "PostgrestClient",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a PostgREST client."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@example",
|
|
"name": "Using supabase-js (recommended)",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('profiles').select('*')\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": "Standalone import for bundle-sensitive environments",
|
|
"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: 'your-publishable-key' },\n schema: 'public',\n timeout: 30000, // 30 second timeout\n})\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 86,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L86"
|
|
}
|
|
],
|
|
"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": 908,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/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/ec39c4f09462d15b1e5991f6407963d933e00e2b/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": 98,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L98"
|
|
}
|
|
],
|
|
"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": 96,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L96"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "HeadersInit"
|
|
},
|
|
"name": "HeadersInit",
|
|
"package": "typescript"
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 34,
|
|
"name": "retry",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Enable or disable automatic retries for transient errors.\n When enabled, idempotent requests (GET, HEAD, OPTIONS) that fail with network\n errors or HTTP 503/520 responses will be automatically retried up to 3 times\n with exponential backoff (1s, 2s, 4s). Defaults to "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`true`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": "."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 101,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L101"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"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": 97,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L97"
|
|
}
|
|
],
|
|
"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": 99,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L99"
|
|
}
|
|
],
|
|
"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": 100,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L100"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "8000"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [24, 22, 34, 23, 32, 33]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 95,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L95"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"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": 38,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L40"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 39,
|
|
"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": 40,
|
|
"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": 41,
|
|
"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": 42,
|
|
"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": 43,
|
|
"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": 44,
|
|
"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": 45,
|
|
"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": 36,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/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": 47,
|
|
"name": "retry",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 44,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L44"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 37,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/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": 35,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L37"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 46,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L41"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 48,
|
|
"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": 152,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L152"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 156,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L156"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 166,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L166"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 49,
|
|
"name": "from",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 152,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L152"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 50,
|
|
"name": "TableName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 51,
|
|
"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": 52,
|
|
"name": "relation",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 50,
|
|
"name": "TableName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 81,
|
|
"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": 51,
|
|
"name": "Table",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 50,
|
|
"name": "TableName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestQueryBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 53,
|
|
"name": "from",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 156,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L156"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 54,
|
|
"name": "ViewName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 55,
|
|
"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": 56,
|
|
"name": "relation",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 54,
|
|
"name": "ViewName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 81,
|
|
"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": 55,
|
|
"name": "View",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 54,
|
|
"name": "ViewName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestQueryBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 61,
|
|
"name": "rpc",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 374,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L374"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 62,
|
|
"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": 374,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L374"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 63,
|
|
"name": "FnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 64,
|
|
"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": 65,
|
|
"name": "FilterBuilder",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/types/common/rpc.ts",
|
|
"qualifiedName": "RpcFunctionNotFound"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 63,
|
|
"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": 63,
|
|
"name": "FnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 64,
|
|
"name": "Args",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "GetRpcFunctionFilterBuilderByArgs",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 66,
|
|
"name": "fn",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The function name to call"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 63,
|
|
"name": "FnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 67,
|
|
"name": "args",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The arguments to pass to the function call"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 64,
|
|
"name": "Args",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"defaultValue": "..."
|
|
},
|
|
{
|
|
"id": 68,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 69,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 72,
|
|
"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": 392,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L392"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 73,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "exact"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "planned"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "estimated"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 71,
|
|
"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": 391,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L391"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 70,
|
|
"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": 390,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L390"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [72, 71, 70]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 389,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L389"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"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": 65,
|
|
"name": "FilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Result"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 65,
|
|
"name": "FilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "RelationName"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 65,
|
|
"name": "FilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Relationships"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 65,
|
|
"name": "FilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "RPC"
|
|
}
|
|
],
|
|
"name": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 57,
|
|
"name": "schema",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 192,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L192"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 58,
|
|
"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": 192,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L192"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 59,
|
|
"name": "DynamicSchema",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 60,
|
|
"name": "schema",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The schema to query"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 59,
|
|
"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": 59,
|
|
"name": "DynamicSchema",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"target": 59,
|
|
"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": [38, 36, 47, 37, 35, 46]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [48, 61, 57]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Database",
|
|
"children": [10, 48, 61, 57]
|
|
},
|
|
{
|
|
"title": "Other",
|
|
"children": [38, 36, 47, 37, 35, 46]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 16,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L16"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 74,
|
|
"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": 75,
|
|
"name": "ClientOptions",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 908,
|
|
"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": 76,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 77,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L19"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "inferred",
|
|
"name": "I",
|
|
"constraint": {
|
|
"type": "reference",
|
|
"target": 908,
|
|
"name": "ClientServerOptions",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [77]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestClient.ts",
|
|
"line": 18,
|
|
"character": 63,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/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": 78,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestClient.ts#L22"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 79,
|
|
"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": 80,
|
|
"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": 867,
|
|
"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": 868,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L24"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 869,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L24"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 870,
|
|
"name": "context",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 871,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 875,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L24"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 873,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L24"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 874,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L24"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 872,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L24"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [875, 873, 874, 872]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestError.ts",
|
|
"line": 24,
|
|
"character": 23,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L24"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 867,
|
|
"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": 878,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L9"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 876,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L7"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 877,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L8"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 879,
|
|
"name": "toJSON",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestError.ts",
|
|
"line": 32,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L32"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 880,
|
|
"name": "toJSON",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestError.ts",
|
|
"line": 32,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L32"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 881,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 886,
|
|
"name": "code",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestError.ts",
|
|
"line": 32,
|
|
"character": 76,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L32"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 884,
|
|
"name": "details",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestError.ts",
|
|
"line": 32,
|
|
"character": 45,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L32"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 885,
|
|
"name": "hint",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestError.ts",
|
|
"line": 32,
|
|
"character": 62,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L32"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 883,
|
|
"name": "message",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestError.ts",
|
|
"line": 32,
|
|
"character": 28,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L32"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 882,
|
|
"name": "name",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestError.ts",
|
|
"line": 32,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L32"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [886, 884, 885, 883, 882]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestError.ts",
|
|
"line": 32,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestError.ts#L32"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [868]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [878, 876, 877]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [879]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestError.ts",
|
|
"line": 6,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/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": 186,
|
|
"name": "PostgrestFilterBuilder",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 187,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 115,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 188,
|
|
"name": "PostgrestFilterBuilder",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a builder configured for a specific PostgREST request."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@example",
|
|
"name": "Using supabase-js (recommended)",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Standalone import for bundle-sensitive environments",
|
|
"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: 'your-publishable-key' }) }\n)\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 115,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 189,
|
|
"name": "ClientOptions",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 908,
|
|
"name": "ClientServerOptions",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 190,
|
|
"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": 191,
|
|
"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": 192,
|
|
"name": "Result",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
},
|
|
{
|
|
"id": 193,
|
|
"name": "RelationName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 194,
|
|
"name": "Relationships",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 195,
|
|
"name": "Method",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 196,
|
|
"name": "builder",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 197,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 202,
|
|
"name": "body",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 120,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 205,
|
|
"name": "fetch",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 123,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 206,
|
|
"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": 207,
|
|
"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": 208,
|
|
"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": 209,
|
|
"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": 210,
|
|
"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": 211,
|
|
"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": 212,
|
|
"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": 200,
|
|
"name": "headers",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 118,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "HeadersInit"
|
|
},
|
|
"name": "HeadersInit",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 213,
|
|
"name": "isMaybeSingle",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 124,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 198,
|
|
"name": "method",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 116,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116"
|
|
}
|
|
],
|
|
"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": 216,
|
|
"name": "retry",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 128,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L128"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 201,
|
|
"name": "schema",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 119,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 214,
|
|
"name": "shouldStripNulls",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 125,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L125"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 203,
|
|
"name": "shouldThrowOnError",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 121,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 204,
|
|
"name": "signal",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 122,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "AbortSignal"
|
|
},
|
|
"name": "AbortSignal",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 199,
|
|
"name": "url",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 117,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 215,
|
|
"name": "urlLengthLimit",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 126,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [202, 205, 200, 213, 198, 216, 201, 214, 203, 204, 199, 215]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 115,
|
|
"character": 23,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 193,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 194,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 195,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 606,
|
|
"name": "default.constructor"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 605,
|
|
"name": "default.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 551,
|
|
"name": "body",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 81,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 721,
|
|
"name": "default.body"
|
|
}
|
|
},
|
|
{
|
|
"id": 554,
|
|
"name": "fetch",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 84,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 555,
|
|
"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": 556,
|
|
"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": 557,
|
|
"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": 558,
|
|
"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": 559,
|
|
"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": 560,
|
|
"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": 561,
|
|
"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": 724,
|
|
"name": "default.fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 549,
|
|
"name": "headers",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 79,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Headers"
|
|
},
|
|
"name": "Headers",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 719,
|
|
"name": "default.headers"
|
|
}
|
|
},
|
|
{
|
|
"id": 562,
|
|
"name": "isMaybeSingle",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 85,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 732,
|
|
"name": "default.isMaybeSingle"
|
|
}
|
|
},
|
|
{
|
|
"id": 547,
|
|
"name": "method",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 77,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77"
|
|
}
|
|
],
|
|
"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": 717,
|
|
"name": "default.method"
|
|
}
|
|
},
|
|
{
|
|
"id": 565,
|
|
"name": "retryEnabled",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 90,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L90"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "true",
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 735,
|
|
"name": "default.retryEnabled"
|
|
}
|
|
},
|
|
{
|
|
"id": 550,
|
|
"name": "schema",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 80,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 720,
|
|
"name": "default.schema"
|
|
}
|
|
},
|
|
{
|
|
"id": 563,
|
|
"name": "shouldStripNulls",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 86,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L86"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 733,
|
|
"name": "default.shouldStripNulls"
|
|
}
|
|
},
|
|
{
|
|
"id": 552,
|
|
"name": "shouldThrowOnError",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 82,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false",
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 722,
|
|
"name": "default.shouldThrowOnError"
|
|
}
|
|
},
|
|
{
|
|
"id": 553,
|
|
"name": "signal",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 83,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "AbortSignal"
|
|
},
|
|
"name": "AbortSignal",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 723,
|
|
"name": "default.signal"
|
|
}
|
|
},
|
|
{
|
|
"id": 548,
|
|
"name": "url",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 78,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 718,
|
|
"name": "default.url"
|
|
}
|
|
},
|
|
{
|
|
"id": 564,
|
|
"name": "urlLengthLimit",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 87,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L87"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 734,
|
|
"name": "default.urlLengthLimit"
|
|
}
|
|
},
|
|
{
|
|
"id": 516,
|
|
"name": "abortSignal",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 598,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 517,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 598,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 518,
|
|
"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": 687,
|
|
"name": "default.abortSignal"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 686,
|
|
"name": "default.abortSignal"
|
|
}
|
|
},
|
|
{
|
|
"id": 355,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 1003,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1003"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1007,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1007"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1138,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1138"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 356,
|
|
"name": "containedBy",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1003,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1003"
|
|
}
|
|
],
|
|
"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": "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": 357,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 360,
|
|
"name": "containedBy",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1007,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1007"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 361,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 362,
|
|
"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": 347,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 854,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L854"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 858,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L858"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 988,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L988"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 348,
|
|
"name": "contains",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 854,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L854"
|
|
}
|
|
],
|
|
"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": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 352,
|
|
"name": "contains",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 858,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L858"
|
|
}
|
|
],
|
|
"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": 525,
|
|
"name": "csv",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 740,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 526,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 740,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"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": 696,
|
|
"name": "default.csv"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 695,
|
|
"name": "default.csv"
|
|
}
|
|
},
|
|
{
|
|
"id": 217,
|
|
"name": "eq",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 158,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L158"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 218,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 158,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L158"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 219,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 220,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The column to filter on"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 219,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"target": 219,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 219,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"falseType": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 219,
|
|
"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": 219,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 219,
|
|
"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": 219,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"target": 219,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"falseType": {
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 221,
|
|
"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": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 219,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "ResolveFilterValue",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
"extendsType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
},
|
|
"trueType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 222,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {}
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ResolveFilterValue"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 219,
|
|
"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": 529,
|
|
"name": "explain",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 851,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 530,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 851,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 531,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 532,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 533,
|
|
"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": 859,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L859"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 536,
|
|
"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": 862,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L862"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 538,
|
|
"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": 864,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L864"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "text"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "json"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "'text'"
|
|
},
|
|
{
|
|
"id": 535,
|
|
"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": 861,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L861"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 534,
|
|
"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": 860,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L860"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 537,
|
|
"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": 863,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L863"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [533, 536, 538, 535, 534, 537]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 858,
|
|
"character": 5,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L858"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"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": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"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": 700,
|
|
"name": "default.explain"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 699,
|
|
"name": "default.explain"
|
|
}
|
|
},
|
|
{
|
|
"id": 455,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 2017,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2017"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 2022,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2022"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 2136,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2136"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 456,
|
|
"name": "filter",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 2017,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2017"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 457,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 458,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 457,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 459,
|
|
"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.is"
|
|
},
|
|
{
|
|
"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.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": 460,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 461,
|
|
"name": "filter",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 2022,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2022"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 462,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 463,
|
|
"name": "operator",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 464,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 527,
|
|
"name": "geojson",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 750,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 528,
|
|
"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": 750,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"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": 698,
|
|
"name": "default.geojson"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 697,
|
|
"name": "default.geojson"
|
|
}
|
|
},
|
|
{
|
|
"id": 228,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 245,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L245"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 246,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L246"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 295,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L295"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 229,
|
|
"name": "gt",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 245,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L245"
|
|
}
|
|
],
|
|
"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": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 233,
|
|
"name": "gt",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 246,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L246"
|
|
}
|
|
],
|
|
"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": 236,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 300,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L300"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 301,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L301"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 350,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L350"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 237,
|
|
"name": "gte",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 300,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L300"
|
|
}
|
|
],
|
|
"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": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 241,
|
|
"name": "gte",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 301,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L301"
|
|
}
|
|
],
|
|
"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": 284,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 550,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L550"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 551,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L551"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 596,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L596"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 285,
|
|
"name": "ilike",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 550,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L550"
|
|
}
|
|
],
|
|
"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": "pattern",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 289,
|
|
"name": "ilike",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 551,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L551"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 290,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 291,
|
|
"name": "pattern",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 292,
|
|
"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"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 601,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L601"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 605,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L605"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 615,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L615"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 293,
|
|
"name": "ilikeAllOf",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 601,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L601"
|
|
}
|
|
],
|
|
"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": "ilikeAllOf",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 605,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L605"
|
|
}
|
|
],
|
|
"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": 300,
|
|
"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"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 620,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L620"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 624,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L624"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 634,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L634"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 301,
|
|
"name": "ilikeAnyOf",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 620,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L620"
|
|
}
|
|
],
|
|
"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": "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": 305,
|
|
"name": "ilikeAnyOf",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 624,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L624"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 306,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 307,
|
|
"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": 337,
|
|
"name": "in",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 801,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L801"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 338,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 801,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L801"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 339,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 340,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The column to filter on"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 339,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 341,
|
|
"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": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 339,
|
|
"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": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 339,
|
|
"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": 324,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 667,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L667"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 671,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L671"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 726,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L726"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 325,
|
|
"name": "is",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 667,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L667"
|
|
}
|
|
],
|
|
"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": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 326,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 328,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"target": 326,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 191,
|
|
"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": 329,
|
|
"name": "is",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 671,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L671"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 330,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 331,
|
|
"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": 332,
|
|
"name": "isDistinct",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 741,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L741"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 333,
|
|
"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": 741,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L741"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 334,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 335,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The column to filter on"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 334,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 336,
|
|
"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": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 334,
|
|
"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": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 334,
|
|
"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": 260,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 461,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L461"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 462,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L462"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 507,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L507"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 261,
|
|
"name": "like",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 461,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L461"
|
|
}
|
|
],
|
|
"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": "pattern",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 265,
|
|
"name": "like",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 462,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L462"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 266,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 267,
|
|
"name": "pattern",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 268,
|
|
"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"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 512,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L512"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 516,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L516"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 526,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L526"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 269,
|
|
"name": "likeAllOf",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 512,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L512"
|
|
}
|
|
],
|
|
"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": "likeAllOf",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 516,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L516"
|
|
}
|
|
],
|
|
"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": 276,
|
|
"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"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 531,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L531"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 535,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L535"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 545,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L545"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 277,
|
|
"name": "likeAnyOf",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 531,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L531"
|
|
}
|
|
],
|
|
"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": "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": 281,
|
|
"name": "likeAnyOf",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 535,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L535"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 282,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 283,
|
|
"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": 501,
|
|
"name": "limit",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 448,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 502,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 448,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 503,
|
|
"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": 504,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 505,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 506,
|
|
"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": 453,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 507,
|
|
"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": 453,
|
|
"character": 32,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "foreignTable"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [506, 507]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 453,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 672,
|
|
"name": "default.limit"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 671,
|
|
"name": "default.limit"
|
|
}
|
|
},
|
|
{
|
|
"id": 244,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 355,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L355"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 356,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L356"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 401,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L401"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 245,
|
|
"name": "lt",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 355,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L355"
|
|
}
|
|
],
|
|
"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": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 249,
|
|
"name": "lt",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 356,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L356"
|
|
}
|
|
],
|
|
"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": 252,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 406,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L406"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 407,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L407"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 456,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L456"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 253,
|
|
"name": "lte",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 406,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L406"
|
|
}
|
|
],
|
|
"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": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"target": 254,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 257,
|
|
"name": "lte",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 407,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L407"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 258,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 259,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 427,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 1708,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1708"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1709,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1709"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1754,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1754"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 428,
|
|
"name": "match",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1708,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1708"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 429,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 430,
|
|
"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": 429,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"target": 429,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
],
|
|
"name": "Record",
|
|
"package": "typescript"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 431,
|
|
"name": "match",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1709,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1709"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 432,
|
|
"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": 544,
|
|
"name": "maxAffected",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 967,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 545,
|
|
"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": 967,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 546,
|
|
"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": 189,
|
|
"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": 195,
|
|
"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": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 193,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 194,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 195,
|
|
"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": 715,
|
|
"name": "default.maxAffected"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 714,
|
|
"name": "default.maxAffected"
|
|
}
|
|
},
|
|
{
|
|
"id": 522,
|
|
"name": "maybeSingle",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 692,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 523,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 692,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 524,
|
|
"name": "ResultOne",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 192,
|
|
"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": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 524,
|
|
"name": "ResultOne",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "PostgrestBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 693,
|
|
"name": "default.maybeSingle"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 692,
|
|
"name": "default.maybeSingle"
|
|
}
|
|
},
|
|
{
|
|
"id": 223,
|
|
"name": "neq",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 227,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L227"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 224,
|
|
"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": ".\n\nThis filter does not include rows where "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`column`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " is "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`NULL`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ". To match null\nvalues, use "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`.is(column, null)`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " instead."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 227,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L227"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 225,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 226,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The column to filter on"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 225,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"target": 225,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 225,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"falseType": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 225,
|
|
"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": 225,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 225,
|
|
"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": 225,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"target": 225,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"falseType": {
|
|
"type": "typeOperator",
|
|
"operator": "keyof",
|
|
"target": {
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 227,
|
|
"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": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 225,
|
|
"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": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 225,
|
|
"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": 433,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 1765,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1765"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1779,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1779"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1784,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1784"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1844,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1844"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 434,
|
|
"name": "not",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1765,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1765"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 435,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 436,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 435,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 437,
|
|
"name": "operator",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "literal",
|
|
"value": "is"
|
|
}
|
|
},
|
|
{
|
|
"id": 438,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "NonNullableColumn"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 435,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "NonNullableColumn",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "NarrowResultColumn"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 435,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "NarrowResultColumn",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 193,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 194,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 195,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 193,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 194,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 195,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 439,
|
|
"name": "not",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1779,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1779"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 440,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 441,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 440,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 442,
|
|
"name": "operator",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "FilterOperator"
|
|
},
|
|
"name": "FilterOperator",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 443,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "reference",
|
|
"target": 440,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 444,
|
|
"name": "not",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1784,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1784"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 445,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 446,
|
|
"name": "operator",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 447,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 342,
|
|
"name": "notIn",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 832,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L832"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 343,
|
|
"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": 832,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L832"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 344,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 345,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The column to filter on"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 344,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 346,
|
|
"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": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 344,
|
|
"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": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 344,
|
|
"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": 448,
|
|
"name": "or",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 2005,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2005"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 449,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 2005,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2005"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 450,
|
|
"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": 451,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 452,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 453,
|
|
"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": 2010,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 454,
|
|
"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": 2010,
|
|
"character": 32,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "foreignTable"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [453, 454]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 2010,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L2010"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 470,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 111,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 115,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 122,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 129,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 322,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L322"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 471,
|
|
"name": "order",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 111,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 472,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 473,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 472,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 474,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 475,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 476,
|
|
"name": "ascending",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 113,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 477,
|
|
"name": "nullsFirst",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 113,
|
|
"character": 37,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 478,
|
|
"name": "referencedTable",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 113,
|
|
"character": 59,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [476, 477, 478]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 113,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 641,
|
|
"name": "default.order"
|
|
}
|
|
},
|
|
{
|
|
"id": 479,
|
|
"name": "order",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 115,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 480,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 481,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 482,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 483,
|
|
"name": "ascending",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 117,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 484,
|
|
"name": "nullsFirst",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 117,
|
|
"character": 37,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 485,
|
|
"name": "referencedTable",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 117,
|
|
"character": 59,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [483, 484, 485]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 117,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 649,
|
|
"name": "default.order"
|
|
}
|
|
},
|
|
{
|
|
"id": 486,
|
|
"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": 122,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 487,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 488,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 487,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 489,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 490,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 491,
|
|
"name": "ascending",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 124,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 493,
|
|
"name": "foreignTable",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 124,
|
|
"character": 59,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
}
|
|
},
|
|
{
|
|
"id": 492,
|
|
"name": "nullsFirst",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 124,
|
|
"character": 37,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [491, 493, 492]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 124,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 656,
|
|
"name": "default.order"
|
|
}
|
|
},
|
|
{
|
|
"id": 494,
|
|
"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": 129,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 495,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 496,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 497,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 498,
|
|
"name": "ascending",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 131,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 500,
|
|
"name": "foreignTable",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 131,
|
|
"character": 59,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 499,
|
|
"name": "nullsFirst",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 131,
|
|
"character": 37,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [498, 500, 499]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 131,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 664,
|
|
"name": "default.order"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 640,
|
|
"name": "default.order"
|
|
}
|
|
},
|
|
{
|
|
"id": 403,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 1468,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1468"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1472,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1472"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1565,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1565"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 404,
|
|
"name": "overlaps",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1468,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1468"
|
|
}
|
|
],
|
|
"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": "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": 405,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 408,
|
|
"name": "overlaps",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1472,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1472"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 409,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 410,
|
|
"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": 589,
|
|
"name": "overrideTypes",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 664,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L664"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 590,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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<Array<MyType>, { 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<MyType, { merge: false }>()\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<Array<{ status: \"A\" | \"B\" }>>()\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@exampleResponse",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Partial Override type of successful response\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nlet x: typeof data // Array<CountryRowProperties & { status: \"A\" | \"B\" }>\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": "Merge vs replace existing types",
|
|
"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": 664,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L664"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 591,
|
|
"name": "NewResult",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The new type to cast the response data to"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 592,
|
|
"name": "Options",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Optional type configuration (defaults to { merge: true })"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 593,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 594,
|
|
"name": "merge",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 22,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [594]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 20,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"default": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 595,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 596,
|
|
"name": "merge",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 44,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": true
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [596]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 42,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"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": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 591,
|
|
"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": 192,
|
|
"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": 591,
|
|
"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": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "NonNullable",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 592,
|
|
"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": 591,
|
|
"name": "NewResult",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 592,
|
|
"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": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 591,
|
|
"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": 760,
|
|
"name": "default.overrideTypes"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 759,
|
|
"name": "default.overrideTypes"
|
|
}
|
|
},
|
|
{
|
|
"id": 508,
|
|
"name": "range",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 515,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 509,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 515,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 510,
|
|
"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": 511,
|
|
"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": 512,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 513,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 514,
|
|
"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": 521,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 515,
|
|
"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": 521,
|
|
"character": 32,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "foreignTable"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [514, 515]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 521,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 679,
|
|
"name": "default.range"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 678,
|
|
"name": "default.range"
|
|
}
|
|
},
|
|
{
|
|
"id": 395,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 1405,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1405"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1406,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1406"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1463,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1463"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 396,
|
|
"name": "rangeAdjacent",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1405,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1405"
|
|
}
|
|
],
|
|
"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": "range",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 400,
|
|
"name": "rangeAdjacent",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1406,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1406"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 401,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 402,
|
|
"name": "range",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 363,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 1152,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1152"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1153,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1153"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1210,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1210"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 364,
|
|
"name": "rangeGt",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1152,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1152"
|
|
}
|
|
],
|
|
"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": "rangeGt",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1153,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1153"
|
|
}
|
|
],
|
|
"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": "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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 1215,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1215"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1216,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1216"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1274,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1274"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 372,
|
|
"name": "rangeGte",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1215,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1215"
|
|
}
|
|
],
|
|
"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": "rangeGte",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1216,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1216"
|
|
}
|
|
],
|
|
"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": "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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 1279,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1279"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1280,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1280"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1336,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1336"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 380,
|
|
"name": "rangeLt",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1279,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1279"
|
|
}
|
|
],
|
|
"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": "rangeLt",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1280,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1280"
|
|
}
|
|
],
|
|
"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": 387,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 1341,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1341"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1342,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1342"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1400,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1400"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 388,
|
|
"name": "rangeLte",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1341,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1341"
|
|
}
|
|
],
|
|
"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": "rangeLte",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1342,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1342"
|
|
}
|
|
],
|
|
"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": 316,
|
|
"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": 653,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L653"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 654,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L654"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 662,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L662"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 317,
|
|
"name": "regexIMatch",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 653,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L653"
|
|
}
|
|
],
|
|
"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": "pattern",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 321,
|
|
"name": "regexIMatch",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 654,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L654"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 322,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 323,
|
|
"name": "pattern",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 308,
|
|
"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": 639,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L639"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 640,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L640"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 648,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L648"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 309,
|
|
"name": "regexMatch",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 639,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L639"
|
|
}
|
|
],
|
|
"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": "regexMatch",
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L640"
|
|
}
|
|
],
|
|
"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": 574,
|
|
"name": "retry",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 251,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L251"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 575,
|
|
"name": "retry",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts."
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 251,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L251"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 576,
|
|
"name": "enabled",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Whether to enable retries for this request"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 745,
|
|
"name": "default.retry"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 744,
|
|
"name": "default.retry"
|
|
}
|
|
},
|
|
{
|
|
"id": 541,
|
|
"name": "returns",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 939,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 542,
|
|
"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<yourType, { merge: false }>() method at the end of your call chain instead"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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<Array<MyType>>()\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<MyType>()\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": 939,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 543,
|
|
"name": "NewResult",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The new result type to override with"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 604,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"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": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 543,
|
|
"name": "NewResult",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "CheckMatchingArrayTypes",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 193,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 194,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 195,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestTransformBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 712,
|
|
"name": "default.returns"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 711,
|
|
"name": "default.returns"
|
|
}
|
|
},
|
|
{
|
|
"id": 539,
|
|
"name": "rollback",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 895,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 540,
|
|
"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": 895,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 710,
|
|
"name": "default.rollback"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 709,
|
|
"name": "default.rollback"
|
|
}
|
|
},
|
|
{
|
|
"id": 465,
|
|
"name": "select",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 62,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 466,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 62,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 467,
|
|
"name": "Query",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"default": {
|
|
"type": "literal",
|
|
"value": "*"
|
|
}
|
|
},
|
|
{
|
|
"id": 468,
|
|
"name": "NewResultOne",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"target": 911,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 193,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 194,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 467,
|
|
"name": "Query",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "GetResult",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 469,
|
|
"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": 467,
|
|
"name": "Query",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 195,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "literal",
|
|
"value": "RPC"
|
|
},
|
|
"trueType": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 192,
|
|
"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": 468,
|
|
"name": "NewResultOne",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "reference",
|
|
"target": 468,
|
|
"name": "NewResultOne",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 468,
|
|
"name": "NewResultOne",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 193,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 194,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 195,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 636,
|
|
"name": "default.select"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 635,
|
|
"name": "default.select"
|
|
}
|
|
},
|
|
{
|
|
"id": 570,
|
|
"name": "setHeader",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 225,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L225"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 571,
|
|
"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": 225,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L225"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 572,
|
|
"name": "name",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 573,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 741,
|
|
"name": "default.setHeader"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 740,
|
|
"name": "default.setHeader"
|
|
}
|
|
},
|
|
{
|
|
"id": 519,
|
|
"name": "single",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 645,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 520,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 645,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 521,
|
|
"name": "ResultOne",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 192,
|
|
"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": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 521,
|
|
"name": "ResultOne",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 690,
|
|
"name": "default.single"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 689,
|
|
"name": "default.single"
|
|
}
|
|
},
|
|
{
|
|
"id": 568,
|
|
"name": "stripNulls",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 212,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L212"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 569,
|
|
"name": "stripNulls",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Strip null values from the response data. Properties with "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`null`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n"
|
|
},
|
|
{
|
|
"kind": "inline-tag",
|
|
"tag": "@link",
|
|
"text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls",
|
|
"target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls"
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "With `select()`",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\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, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\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 \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 212,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L212"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 739,
|
|
"name": "default.stripNulls"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 738,
|
|
"name": "default.stripNulls"
|
|
}
|
|
},
|
|
{
|
|
"id": 411,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 1576,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1576"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1581,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1581"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1690,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1690"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 412,
|
|
"name": "textSearch",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1576,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1576"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 413,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 414,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 413,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 415,
|
|
"name": "query",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 416,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 417,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 418,
|
|
"name": "config",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1579,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 419,
|
|
"name": "type",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1579,
|
|
"character": 33,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "plain"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phrase"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "websearch"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [418, 419]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1579,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1579"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 420,
|
|
"name": "textSearch",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1581,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1581"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 421,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 422,
|
|
"name": "query",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 423,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 424,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 425,
|
|
"name": "config",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1584,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 426,
|
|
"name": "type",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1584,
|
|
"character": 33,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "plain"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "phrase"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "websearch"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [425, 426]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 1584,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L1584"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 577,
|
|
"name": "then",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 256,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L256"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 578,
|
|
"name": "then",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Attaches callbacks for the resolution and/or rejection of the Promise."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "A Promise for the completion of which ever callback is executed."
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 256,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L256"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 579,
|
|
"name": "TResult1",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"target": 904,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 580,
|
|
"name": "TResult2",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 581,
|
|
"name": "onfulfilled",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The callback to execute when the Promise is resolved."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 582,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 263,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L263"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 583,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 263,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L263"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 584,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 904,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 579,
|
|
"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": 579,
|
|
"name": "TResult1",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 585,
|
|
"name": "onrejected",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The callback to execute when the Promise is rejected."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 586,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 270,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L270"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 587,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 270,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L270"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 588,
|
|
"name": "reason",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 580,
|
|
"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": 580,
|
|
"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": 579,
|
|
"name": "TResult1",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 580,
|
|
"name": "TResult2",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 748,
|
|
"name": "default.then"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 747,
|
|
"name": "default.then"
|
|
}
|
|
},
|
|
{
|
|
"id": 566,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 157,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L157"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 567,
|
|
"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": 157,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L157"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 193,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 194,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 195,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 192,
|
|
"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": 737,
|
|
"name": "default.throwOnError"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 736,
|
|
"name": "default.throwOnError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [187]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [551, 554, 549, 562, 547, 565, 550, 563, 552, 553, 548, 564]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [
|
|
516, 355, 347, 525, 217, 529, 455, 527, 228, 236, 284, 292, 300, 337, 324, 332, 260,
|
|
268, 276, 501, 244, 252, 427, 544, 522, 223, 433, 342, 448, 470, 403, 589, 508, 395,
|
|
363, 371, 379, 387, 316, 308, 574, 541, 539, 465, 570, 519, 568, 411, 577, 566
|
|
]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Database",
|
|
"children": [
|
|
187, 516, 355, 347, 525, 217, 529, 455, 527, 228, 236, 284, 292, 300, 337, 324, 260,
|
|
268, 276, 501, 244, 252, 427, 544, 522, 223, 433, 448, 470, 403, 589, 508, 395, 363,
|
|
371, 379, 387, 541, 539, 465, 570, 519, 568, 411, 566
|
|
]
|
|
},
|
|
{
|
|
"title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.",
|
|
"children": [574]
|
|
},
|
|
{
|
|
"title": "Other",
|
|
"children": [
|
|
551, 554, 549, 562, 547, 565, 550, 563, 552, 553, 548, 564, 332, 342, 316, 308, 577
|
|
]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestFilterBuilder.ts",
|
|
"line": 95,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestFilterBuilder.ts#L95"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 597,
|
|
"name": "ClientOptions",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 908,
|
|
"name": "ClientServerOptions",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 598,
|
|
"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": 599,
|
|
"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": 600,
|
|
"name": "Result",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
},
|
|
{
|
|
"id": 601,
|
|
"name": "RelationName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 602,
|
|
"name": "Relationships",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 603,
|
|
"name": "Method",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 604,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 189,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 190,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 191,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 192,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 193,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 194,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 195,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "default",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 81,
|
|
"name": "PostgrestQueryBuilder",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 82,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 65,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L65"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 83,
|
|
"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": "Using supabase-js (recommended)",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Standalone import for bundle-sensitive environments",
|
|
"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: 'your-publishable-key' }, retry: true }\n)\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 65,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L65"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 84,
|
|
"name": "ClientOptions",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 908,
|
|
"name": "ClientServerOptions",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 85,
|
|
"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": 86,
|
|
"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": 87,
|
|
"name": "RelationName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 88,
|
|
"name": "Relationships",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 89,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 90,
|
|
"name": "Relationships",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 17,
|
|
"character": 37,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "R"
|
|
},
|
|
"name": "R",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [90]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 17,
|
|
"character": 35,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"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": 91,
|
|
"name": "url",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The URL for the query"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 92,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 93,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 96,
|
|
"name": "fetch",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Custom fetch implementation"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 76,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L76"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 97,
|
|
"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": 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/typescript/lib/lib.dom.d.ts",
|
|
"line": 29329,
|
|
"character": 17
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 99,
|
|
"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": 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": 101,
|
|
"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": 102,
|
|
"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": 103,
|
|
"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": 94,
|
|
"name": "headers",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Custom headers"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 74,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L74"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "HeadersInit"
|
|
},
|
|
"name": "HeadersInit",
|
|
"package": "typescript"
|
|
},
|
|
"defaultValue": "{}"
|
|
},
|
|
{
|
|
"id": 105,
|
|
"name": "retry",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Enable automatic retries for transient errors (default: true)"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 78,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L78"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 95,
|
|
"name": "schema",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Postgres schema to use"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 75,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L75"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 104,
|
|
"name": "urlLengthLimit",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Maximum URL length before warning"
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 77,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L77"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"defaultValue": "8000"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [96, 94, 105, 95, 104]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 73,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L73"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 81,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 84,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 85,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 87,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 88,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestQueryBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 110,
|
|
"name": "fetch",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 23,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L23"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 111,
|
|
"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": 112,
|
|
"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": 113,
|
|
"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": 114,
|
|
"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": 115,
|
|
"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": 116,
|
|
"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": 117,
|
|
"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": 107,
|
|
"name": "headers",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 20,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L20"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Headers"
|
|
},
|
|
"name": "Headers",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 119,
|
|
"name": "retry",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Enable or disable automatic retries for transient errors.\nWhen enabled, idempotent requests (GET/HEAD/OPTIONS) that fail with network\nerrors or HTTP 503/520 responses are automatically retried with exponential\nbackoff (1s, 2s, 4s, up to 3 attempts). Defaults to "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`true`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " when not specified."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 32,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L32"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 108,
|
|
"name": "schema",
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L21"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 109,
|
|
"name": "signal",
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L22"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "AbortSignal"
|
|
},
|
|
"name": "AbortSignal",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 106,
|
|
"name": "url",
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L19"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 118,
|
|
"name": "urlLengthLimit",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 24,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L24"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"id": 173,
|
|
"name": "delete",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1673,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1673"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 174,
|
|
"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": 1673,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1673"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 175,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 176,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 177,
|
|
"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": 1676,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1676"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 178,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "exact"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "planned"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "estimated"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [177]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1675,
|
|
"character": 5,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1675"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 84,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 85,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 87,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 88,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "DELETE"
|
|
}
|
|
],
|
|
"name": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 135,
|
|
"name": "insert",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1050,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1050"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 136,
|
|
"name": "insert",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"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": "@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": 1050,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1050"
|
|
}
|
|
],
|
|
"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": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The values to insert. Pass an object to insert a single row\nor an array to insert multiple rows."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "RejectExcessProperties"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 139,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 140,
|
|
"name": "Insert",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1053,
|
|
"character": 29,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1053"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [140]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1053,
|
|
"character": 27,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1053"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Insert"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 137,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "RejectExcessProperties",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "RejectExcessProperties"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 141,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 142,
|
|
"name": "Insert",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1057,
|
|
"character": 29,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1057"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [142]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1057,
|
|
"character": 27,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1057"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Insert"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 137,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "RejectExcessProperties",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 143,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 144,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 145,
|
|
"name": "count",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"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."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1064,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1064"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 146,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "exact"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "planned"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "estimated"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 147,
|
|
"name": "defaultToNull",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"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."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1065,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1065"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "true"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [145, 147]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1063,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1063"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 84,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 85,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 87,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 88,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "POST"
|
|
}
|
|
],
|
|
"name": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 125,
|
|
"name": "select",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 878,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L878"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 126,
|
|
"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": 878,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L878"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 127,
|
|
"name": "Query",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"default": {
|
|
"type": "literal",
|
|
"value": "*"
|
|
}
|
|
},
|
|
{
|
|
"id": 128,
|
|
"name": "ResultOne",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"target": 911,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 85,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 87,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 88,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 127,
|
|
"name": "Query",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 84,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "GetResult",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 129,
|
|
"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": 127,
|
|
"name": "Query",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 130,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 131,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 133,
|
|
"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": 892,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L892"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 134,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "exact"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "planned"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "estimated"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 132,
|
|
"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": 891,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L891"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [133, 132]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 890,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L890"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 84,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 85,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 128,
|
|
"name": "ResultOne",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 87,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 88,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "GET"
|
|
}
|
|
],
|
|
"name": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 163,
|
|
"name": "update",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1517,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1517"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 164,
|
|
"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": 1517,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1517"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 165,
|
|
"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": 166,
|
|
"name": "values",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The values to update with"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "RejectExcessProperties"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 167,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 168,
|
|
"name": "Update",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1519,
|
|
"character": 25,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1519"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [168]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1519,
|
|
"character": 23,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1519"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Update"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 165,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "RejectExcessProperties",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 169,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 170,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 171,
|
|
"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": 1525,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1525"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 172,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "exact"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "planned"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "estimated"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [171]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1524,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1524"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 84,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 85,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 87,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 88,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "PATCH"
|
|
}
|
|
],
|
|
"name": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 148,
|
|
"name": "upsert",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1315,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1315"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 149,
|
|
"name": "upsert",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"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": "@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": 1315,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1315"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 150,
|
|
"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": 151,
|
|
"name": "values",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The values to upsert with. Pass an object to upsert a\nsingle row or an array to upsert multiple rows."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "RejectExcessProperties"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 152,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 153,
|
|
"name": "Insert",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1318,
|
|
"character": 29,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1318"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [153]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1318,
|
|
"character": 27,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1318"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Insert"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 150,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "RejectExcessProperties",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "RejectExcessProperties"
|
|
},
|
|
"typeArguments": [
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 154,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 155,
|
|
"name": "Insert",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1322,
|
|
"character": 29,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1322"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [155]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1322,
|
|
"character": 27,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1322"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Insert"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 150,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "RejectExcessProperties",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 156,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 157,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 160,
|
|
"name": "count",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"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."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1333,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1333"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 161,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "exact"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "planned"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "estimated"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 162,
|
|
"name": "defaultToNull",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"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."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1334,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1334"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "true"
|
|
},
|
|
{
|
|
"id": 159,
|
|
"name": "ignoreDuplicates",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"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."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1332,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1332"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 158,
|
|
"name": "onConflict",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"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."
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1331,
|
|
"character": 6,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1331"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [160, 162, 159, 158]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 1330,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L1330"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 84,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 85,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "indexedAccess",
|
|
"indexType": {
|
|
"type": "literal",
|
|
"value": "Row"
|
|
},
|
|
"objectType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 87,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 88,
|
|
"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": [82]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [110, 107, 119, 108, 109, 106, 118]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [173, 135, 125, 163, 148]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Database",
|
|
"children": [82, 173, 135, 125, 163, 148]
|
|
},
|
|
{
|
|
"title": "Other",
|
|
"children": [110, 107, 119, 108, 109, 106, 118]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 12,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L12"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 179,
|
|
"name": "ClientOptions",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 908,
|
|
"name": "ClientServerOptions",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 180,
|
|
"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": 181,
|
|
"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": 182,
|
|
"name": "RelationName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 183,
|
|
"name": "Relationships",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 86,
|
|
"name": "Relation",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relation",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 184,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 185,
|
|
"name": "Relationships",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 17,
|
|
"character": 37,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "inferred",
|
|
"name": "R"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [185]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestQueryBuilder.ts",
|
|
"line": 17,
|
|
"character": 35,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestQueryBuilder.ts#L17"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "R"
|
|
},
|
|
"name": "R",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"falseType": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 604,
|
|
"name": "PostgrestTransformBuilder",
|
|
"variant": "declaration",
|
|
"kind": 128,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 605,
|
|
"name": "constructor",
|
|
"variant": "declaration",
|
|
"kind": 512,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 115,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 606,
|
|
"name": "PostgrestTransformBuilder",
|
|
"variant": "signature",
|
|
"kind": 16384,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Creates a builder configured for a specific PostgREST request."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@example",
|
|
"name": "Using supabase-js (recommended)",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nimport { createClient } from '@supabase/supabase-js'\n\nconst supabase = createClient('https://xyzcompany.supabase.co', 'your-publishable-key')\nconst { data, error } = await supabase.from('users').select('*')\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "Standalone import for bundle-sensitive environments",
|
|
"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: 'your-publishable-key' }) }\n)\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 115,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 607,
|
|
"name": "ClientOptions",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 908,
|
|
"name": "ClientServerOptions",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 608,
|
|
"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": 609,
|
|
"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": 610,
|
|
"name": "Result",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
},
|
|
{
|
|
"id": 611,
|
|
"name": "RelationName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 612,
|
|
"name": "Relationships",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 613,
|
|
"name": "Method",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 614,
|
|
"name": "builder",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 615,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 620,
|
|
"name": "body",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 120,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L120"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 623,
|
|
"name": "fetch",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 123,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L123"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 624,
|
|
"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": 625,
|
|
"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": 626,
|
|
"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": 627,
|
|
"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": 628,
|
|
"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": 629,
|
|
"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": 630,
|
|
"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": 618,
|
|
"name": "headers",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 118,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L118"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "HeadersInit"
|
|
},
|
|
"name": "HeadersInit",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 631,
|
|
"name": "isMaybeSingle",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 124,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L124"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 616,
|
|
"name": "method",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 116,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L116"
|
|
}
|
|
],
|
|
"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": 634,
|
|
"name": "retry",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 128,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L128"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 619,
|
|
"name": "schema",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 119,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L119"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 632,
|
|
"name": "shouldStripNulls",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 125,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L125"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 621,
|
|
"name": "shouldThrowOnError",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 121,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L121"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 622,
|
|
"name": "signal",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 122,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L122"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "AbortSignal"
|
|
},
|
|
"name": "AbortSignal",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 617,
|
|
"name": "url",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 117,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L117"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
}
|
|
},
|
|
{
|
|
"id": 633,
|
|
"name": "urlLengthLimit",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 126,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L126"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [620, 623, 618, 631, 616, 634, 619, 632, 621, 622, 617, 633]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 115,
|
|
"character": 23,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L115"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 604,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 608,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 609,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 610,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 611,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 612,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 613,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestTransformBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 776,
|
|
"name": "default.constructor"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 775,
|
|
"name": "default.constructor"
|
|
}
|
|
},
|
|
{
|
|
"id": 721,
|
|
"name": "body",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 81,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L81"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 805,
|
|
"name": "default.body"
|
|
}
|
|
},
|
|
{
|
|
"id": 724,
|
|
"name": "fetch",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 84,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L84"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 725,
|
|
"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": 726,
|
|
"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": 727,
|
|
"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": 728,
|
|
"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": 729,
|
|
"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": 730,
|
|
"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": 731,
|
|
"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": 808,
|
|
"name": "default.fetch"
|
|
}
|
|
},
|
|
{
|
|
"id": 719,
|
|
"name": "headers",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 79,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L79"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "Headers"
|
|
},
|
|
"name": "Headers",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 803,
|
|
"name": "default.headers"
|
|
}
|
|
},
|
|
{
|
|
"id": 732,
|
|
"name": "isMaybeSingle",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 85,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L85"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 816,
|
|
"name": "default.isMaybeSingle"
|
|
}
|
|
},
|
|
{
|
|
"id": 717,
|
|
"name": "method",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 77,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L77"
|
|
}
|
|
],
|
|
"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": 801,
|
|
"name": "default.method"
|
|
}
|
|
},
|
|
{
|
|
"id": 735,
|
|
"name": "retryEnabled",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 90,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L90"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "true",
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 819,
|
|
"name": "default.retryEnabled"
|
|
}
|
|
},
|
|
{
|
|
"id": 720,
|
|
"name": "schema",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 80,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L80"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 804,
|
|
"name": "default.schema"
|
|
}
|
|
},
|
|
{
|
|
"id": 733,
|
|
"name": "shouldStripNulls",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 86,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L86"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 817,
|
|
"name": "default.shouldStripNulls"
|
|
}
|
|
},
|
|
{
|
|
"id": 722,
|
|
"name": "shouldThrowOnError",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 82,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L82"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false",
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 806,
|
|
"name": "default.shouldThrowOnError"
|
|
}
|
|
},
|
|
{
|
|
"id": 723,
|
|
"name": "signal",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isOptional": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 83,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L83"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "AbortSignal"
|
|
},
|
|
"name": "AbortSignal",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 807,
|
|
"name": "default.signal"
|
|
}
|
|
},
|
|
{
|
|
"id": 718,
|
|
"name": "url",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 78,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L78"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "URL"
|
|
},
|
|
"name": "URL",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 802,
|
|
"name": "default.url"
|
|
}
|
|
},
|
|
{
|
|
"id": 734,
|
|
"name": "urlLengthLimit",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isProtected": true,
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 87,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L87"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 818,
|
|
"name": "default.urlLengthLimit"
|
|
}
|
|
},
|
|
{
|
|
"id": 686,
|
|
"name": "abortSignal",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 598,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 687,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 598,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L598"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 688,
|
|
"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": 695,
|
|
"name": "csv",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 740,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 696,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 740,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L740"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
],
|
|
"name": "PostgrestBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 699,
|
|
"name": "explain",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 851,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 700,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 851,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L851"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 701,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 702,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 703,
|
|
"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": 859,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L859"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 706,
|
|
"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": 862,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L862"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 708,
|
|
"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": 864,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L864"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": "text"
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": "json"
|
|
}
|
|
]
|
|
},
|
|
"defaultValue": "'text'"
|
|
},
|
|
{
|
|
"id": 705,
|
|
"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": 861,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L861"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 704,
|
|
"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": 860,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L860"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
},
|
|
{
|
|
"id": 707,
|
|
"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": 863,
|
|
"character": 4,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L863"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
},
|
|
"defaultValue": "false"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [703, 706, 708, 705, 704, 707]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 858,
|
|
"character": 5,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L858"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"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": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"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": 697,
|
|
"name": "geojson",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 750,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 698,
|
|
"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": 750,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L750"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"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": 671,
|
|
"name": "limit",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 448,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 672,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 448,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L448"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 673,
|
|
"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": 674,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 675,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 676,
|
|
"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": 453,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 677,
|
|
"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": 453,
|
|
"character": 32,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "foreignTable"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [676, 677]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 453,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L453"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 714,
|
|
"name": "maxAffected",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 967,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 715,
|
|
"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": 967,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L967"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 716,
|
|
"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": 607,
|
|
"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": 613,
|
|
"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": 604,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 608,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 609,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 610,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 611,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 612,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 613,
|
|
"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": 692,
|
|
"name": "maybeSingle",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 692,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 693,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 692,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L692"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 694,
|
|
"name": "ResultOne",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 610,
|
|
"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": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 524,
|
|
"name": "ResultOne",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "PostgrestBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 640,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 111,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 115,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 122,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 129,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129"
|
|
},
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 322,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L322"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 641,
|
|
"name": "order",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 111,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L111"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 642,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 643,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 472,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"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": 113,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 647,
|
|
"name": "nullsFirst",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 113,
|
|
"character": 37,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 648,
|
|
"name": "referencedTable",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 113,
|
|
"character": 59,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [646, 647, 648]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 113,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L113"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 649,
|
|
"name": "order",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 115,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L115"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 650,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 651,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 652,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 653,
|
|
"name": "ascending",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 117,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 654,
|
|
"name": "nullsFirst",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 117,
|
|
"character": 37,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 655,
|
|
"name": "referencedTable",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 117,
|
|
"character": 59,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [653, 654, 655]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 117,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L117"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 656,
|
|
"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": 122,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L122"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 657,
|
|
"name": "ColumnName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 658,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 487,
|
|
"name": "ColumnName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 659,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 660,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 661,
|
|
"name": "ascending",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 124,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 663,
|
|
"name": "foreignTable",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 124,
|
|
"character": 59,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "undefined"
|
|
}
|
|
},
|
|
{
|
|
"id": 662,
|
|
"name": "nullsFirst",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 124,
|
|
"character": 37,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [661, 663, 662]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 124,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L124"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
},
|
|
{
|
|
"id": 664,
|
|
"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": 129,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L129"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 665,
|
|
"name": "column",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 666,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 667,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 668,
|
|
"name": "ascending",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 131,
|
|
"character": 16,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"id": 670,
|
|
"name": "foreignTable",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 131,
|
|
"character": 59,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 669,
|
|
"name": "nullsFirst",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 131,
|
|
"character": 37,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [668, 670, 669]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 131,
|
|
"character": 14,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L131"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 759,
|
|
"name": "overrideTypes",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 664,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L664"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 760,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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<Array<MyType>, { 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<MyType, { merge: false }>()\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<Array<{ status: \"A\" | \"B\" }>>()\n```"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@exampleResponse",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Partial Override type of successful response\n"
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nlet x: typeof data // Array<CountryRowProperties & { status: \"A\" | \"B\" }>\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": "Merge vs replace existing types",
|
|
"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": 664,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L664"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 761,
|
|
"name": "NewResult",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The new type to cast the response data to"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 762,
|
|
"name": "Options",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Optional type configuration (defaults to { merge: true })"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 763,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 764,
|
|
"name": "merge",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 22,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [764]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 20,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"default": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 765,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 766,
|
|
"name": "merge",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 44,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": true
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [766]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 666,
|
|
"character": 42,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L666"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"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": 610,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 591,
|
|
"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": 610,
|
|
"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": 591,
|
|
"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": 610,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "NonNullable",
|
|
"package": "typescript"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 592,
|
|
"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": 591,
|
|
"name": "NewResult",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 610,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 592,
|
|
"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": 610,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 591,
|
|
"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": 857,
|
|
"name": "default.overrideTypes"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 856,
|
|
"name": "default.overrideTypes"
|
|
}
|
|
},
|
|
{
|
|
"id": 678,
|
|
"name": "range",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 515,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 679,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 515,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L515"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 680,
|
|
"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": 681,
|
|
"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": 682,
|
|
"name": "options",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Named parameters"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 683,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 684,
|
|
"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": 521,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 685,
|
|
"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": 521,
|
|
"character": 32,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"defaultValue": "foreignTable"
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [684, 685]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 521,
|
|
"character": 7,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L521"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"defaultValue": "{}"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 744,
|
|
"name": "retry",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 251,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L251"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 745,
|
|
"name": "retry",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts."
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\n// Disable retries for a specific query\nconst { data, error } = await supabase\n .from('users')\n .select()\n .retry(false)\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 251,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L251"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 746,
|
|
"name": "enabled",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Whether to enable retries for this request"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 829,
|
|
"name": "default.retry"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 828,
|
|
"name": "default.retry"
|
|
}
|
|
},
|
|
{
|
|
"id": 711,
|
|
"name": "returns",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 939,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 712,
|
|
"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<yourType, { merge: false }>() method at the end of your call chain instead"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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<Array<MyType>>()\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<MyType>()\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": 939,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L939"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 713,
|
|
"name": "NewResult",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The new result type to override with"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 604,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 608,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 609,
|
|
"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": 610,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 543,
|
|
"name": "NewResult",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "CheckMatchingArrayTypes",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 611,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 612,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 613,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestTransformBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
},
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 854,
|
|
"name": "default.returns"
|
|
}
|
|
}
|
|
],
|
|
"overwrites": {
|
|
"type": "reference",
|
|
"target": 853,
|
|
"name": "default.returns"
|
|
}
|
|
},
|
|
{
|
|
"id": 709,
|
|
"name": "rollback",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 895,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 710,
|
|
"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": 895,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L895"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 635,
|
|
"name": "select",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 62,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 636,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 62,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L62"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 637,
|
|
"name": "Query",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"default": {
|
|
"type": "literal",
|
|
"value": "*"
|
|
}
|
|
},
|
|
{
|
|
"id": 638,
|
|
"name": "NewResultOne",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"target": 911,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 608,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 609,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 611,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 612,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 467,
|
|
"name": "Query",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "GetResult",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 639,
|
|
"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": 467,
|
|
"name": "Query",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 608,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 609,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 613,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "literal",
|
|
"value": "RPC"
|
|
},
|
|
"trueType": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 610,
|
|
"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": 468,
|
|
"name": "NewResultOne",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "reference",
|
|
"target": 468,
|
|
"name": "NewResultOne",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
"falseType": {
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 468,
|
|
"name": "NewResultOne",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 611,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 612,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 613,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestFilterBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 740,
|
|
"name": "setHeader",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 225,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L225"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 741,
|
|
"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": 225,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L225"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 742,
|
|
"name": "name",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"id": 743,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 825,
|
|
"name": "default.setHeader"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 824,
|
|
"name": "default.setHeader"
|
|
}
|
|
},
|
|
{
|
|
"id": 689,
|
|
"name": "single",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 645,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 690,
|
|
"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": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": 645,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L645"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 691,
|
|
"name": "ResultOne",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 610,
|
|
"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": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 521,
|
|
"name": "ResultOne",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 738,
|
|
"name": "stripNulls",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 212,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L212"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 739,
|
|
"name": "stripNulls",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Strip null values from the response data. Properties with "
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`null`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": " values\nwill be omitted from the returned JSON objects.\n\nRequires PostgREST 11.2.0+.\n\n"
|
|
},
|
|
{
|
|
"kind": "inline-tag",
|
|
"tag": "@link",
|
|
"text": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls",
|
|
"target": "https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls"
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@category",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Database"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@subcategory",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Using modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tag": "@example",
|
|
"name": "With `select()`",
|
|
"content": [
|
|
{
|
|
"kind": "code",
|
|
"text": "```ts\nconst { data, error } = await supabase\n .from('characters')\n .select()\n .stripNulls()\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, bio text);\n\ninsert into\n characters (id, name, bio)\nvalues\n (1, 'Luke', null),\n (2, 'Leia', 'Princess of Alderaan');\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 \"bio\": \"Princess of Alderaan\"\n }\n ],\n \"status\": 200,\n \"statusText\": \"OK\"\n}\n```"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 212,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L212"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "this"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 823,
|
|
"name": "default.stripNulls"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 822,
|
|
"name": "default.stripNulls"
|
|
}
|
|
},
|
|
{
|
|
"id": 747,
|
|
"name": "then",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 256,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L256"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 748,
|
|
"name": "then",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Attaches callbacks for the resolution and/or rejection of the Promise."
|
|
}
|
|
],
|
|
"blockTags": [
|
|
{
|
|
"tag": "@returns",
|
|
"content": [
|
|
{
|
|
"kind": "text",
|
|
"text": "A Promise for the completion of which ever callback is executed."
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 256,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L256"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 749,
|
|
"name": "TResult1",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "reference",
|
|
"target": 904,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 610,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 750,
|
|
"name": "TResult2",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "never"
|
|
}
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 751,
|
|
"name": "onfulfilled",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The callback to execute when the Promise is resolved."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 752,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 263,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L263"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 753,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 263,
|
|
"character": 9,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L263"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 754,
|
|
"name": "value",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 904,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 610,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 579,
|
|
"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": 579,
|
|
"name": "TResult1",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 755,
|
|
"name": "onrejected",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The callback to execute when the Promise is rejected."
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 756,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 270,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L270"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 757,
|
|
"name": "__type",
|
|
"variant": "signature",
|
|
"kind": 4096,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 270,
|
|
"character": 18,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L270"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"id": 758,
|
|
"name": "reason",
|
|
"variant": "param",
|
|
"kind": 32768,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "any"
|
|
}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 580,
|
|
"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": 580,
|
|
"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": 579,
|
|
"name": "TResult1",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 580,
|
|
"name": "TResult2",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "PromiseLike",
|
|
"package": "typescript"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 832,
|
|
"name": "default.then"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 831,
|
|
"name": "default.then"
|
|
}
|
|
},
|
|
{
|
|
"id": 736,
|
|
"name": "throwOnError",
|
|
"variant": "declaration",
|
|
"kind": 2048,
|
|
"flags": {
|
|
"isInherited": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestBuilder.ts",
|
|
"line": 157,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L157"
|
|
}
|
|
],
|
|
"signatures": [
|
|
{
|
|
"id": 737,
|
|
"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": 157,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestBuilder.ts#L157"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intersection",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 604,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 608,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Schema",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 609,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Row",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 610,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 611,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.RelationName",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 612,
|
|
"name": "Relationships",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Relationships",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 613,
|
|
"name": "Method",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Method",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestTransformBuilder",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 610,
|
|
"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": 821,
|
|
"name": "default.throwOnError"
|
|
}
|
|
}
|
|
],
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": 820,
|
|
"name": "default.throwOnError"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Constructors",
|
|
"children": [605]
|
|
},
|
|
{
|
|
"title": "Properties",
|
|
"children": [721, 724, 719, 732, 717, 735, 720, 733, 722, 723, 718, 734]
|
|
},
|
|
{
|
|
"title": "Methods",
|
|
"children": [
|
|
686, 695, 699, 697, 671, 714, 692, 640, 759, 678, 744, 711, 709, 635, 740, 689, 738,
|
|
747, 736
|
|
]
|
|
}
|
|
],
|
|
"categories": [
|
|
{
|
|
"title": "Database",
|
|
"children": [
|
|
605, 686, 695, 699, 697, 671, 714, 692, 640, 759, 678, 711, 709, 635, 740, 689, 738, 736
|
|
]
|
|
},
|
|
{
|
|
"title": "Database\n\nConfigure retry behavior for this request.\n\nBy default, retries are enabled for idempotent requests (GET, HEAD, OPTIONS)\nthat fail with network errors or specific HTTP status codes (503, 520).\nRetries use exponential backoff (1s, 2s, 4s) with a maximum of 3 attempts.",
|
|
"children": [744]
|
|
},
|
|
{
|
|
"title": "Other",
|
|
"children": [721, 724, 719, 732, 717, 735, 720, 733, 722, 723, 718, 734, 747]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/PostgrestTransformBuilder.ts",
|
|
"line": 8,
|
|
"character": 21,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/PostgrestTransformBuilder.ts#L8"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 767,
|
|
"name": "ClientOptions",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 908,
|
|
"name": "ClientServerOptions",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 768,
|
|
"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": 769,
|
|
"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": 770,
|
|
"name": "Result",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
},
|
|
{
|
|
"id": 771,
|
|
"name": "RelationName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 772,
|
|
"name": "Relationships",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
},
|
|
{
|
|
"id": 773,
|
|
"name": "Method",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"default": {
|
|
"type": "intrinsic",
|
|
"name": "unknown"
|
|
}
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": 774,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 607,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.ClientOptions",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 610,
|
|
"name": "Result",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default.Result",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "default",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
],
|
|
"extendedBy": [
|
|
{
|
|
"type": "reference",
|
|
"target": 186,
|
|
"name": "PostgrestFilterBuilder"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 889,
|
|
"name": "PostgrestResponseFailure",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 893,
|
|
"name": "count",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/types/types.ts",
|
|
"line": 25,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L25"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 892,
|
|
"name": "data",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/types/types.ts",
|
|
"line": 24,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L24"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 891,
|
|
"name": "error",
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L23"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 867,
|
|
"name": "PostgrestError",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "default"
|
|
}
|
|
},
|
|
{
|
|
"id": 894,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L12"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "PostgrestResponseBase.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 895,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L13"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "PostgrestResponseBase.statusText"
|
|
}
|
|
},
|
|
{
|
|
"id": 890,
|
|
"name": "success",
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L22"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": false
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [893, 892, 891, 894, 895, 890]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/types/types.ts",
|
|
"line": 21,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L21"
|
|
}
|
|
],
|
|
"extendedTypes": [
|
|
{
|
|
"type": "reference",
|
|
"target": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseBase"
|
|
},
|
|
"name": "PostgrestResponseBase",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": 896,
|
|
"name": "PostgrestResponseSuccess",
|
|
"variant": "declaration",
|
|
"kind": 256,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 900,
|
|
"name": "count",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/types/types.ts",
|
|
"line": 19,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L19"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
},
|
|
{
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 899,
|
|
"name": "data",
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L18"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 903,
|
|
"name": "T",
|
|
"package": "@supabase/postgrest-js",
|
|
"qualifiedName": "PostgrestResponseSuccess.T",
|
|
"refersToTypeParameter": true
|
|
}
|
|
},
|
|
{
|
|
"id": 898,
|
|
"name": "error",
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L17"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
},
|
|
{
|
|
"id": 901,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L12"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "number"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "PostgrestResponseBase.status"
|
|
}
|
|
},
|
|
{
|
|
"id": 902,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L13"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"inheritedFrom": {
|
|
"type": "reference",
|
|
"target": -1,
|
|
"name": "PostgrestResponseBase.statusText"
|
|
}
|
|
},
|
|
{
|
|
"id": 897,
|
|
"name": "success",
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L16"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "literal",
|
|
"value": true
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [900, 899, 898, 901, 902, 897]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/types/types.ts",
|
|
"line": 15,
|
|
"character": 17,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L15"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 903,
|
|
"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": 908,
|
|
"name": "PostgrestClientOptions",
|
|
"variant": "declaration",
|
|
"kind": 2097152,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/types/common/common.ts",
|
|
"line": 81,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/common/common.ts#L81"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reflection",
|
|
"declaration": {
|
|
"id": 909,
|
|
"name": "__type",
|
|
"variant": "declaration",
|
|
"kind": 65536,
|
|
"flags": {},
|
|
"children": [
|
|
{
|
|
"id": 910,
|
|
"name": "PostgrestVersion",
|
|
"variant": "declaration",
|
|
"kind": 1024,
|
|
"flags": {
|
|
"isOptional": true
|
|
},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/types/common/common.ts",
|
|
"line": 82,
|
|
"character": 2,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/common/common.ts#L82"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Properties",
|
|
"children": [910]
|
|
}
|
|
],
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/types/common/common.ts",
|
|
"line": 81,
|
|
"character": 34,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/common/common.ts#L81"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"id": 906,
|
|
"name": "PostgrestMaybeSingleResponse",
|
|
"variant": "declaration",
|
|
"kind": 2097152,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/types/types.ts",
|
|
"line": 32,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L32"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 907,
|
|
"name": "T",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 904,
|
|
"typeArguments": [
|
|
{
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 907,
|
|
"name": "T",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "literal",
|
|
"value": null
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 887,
|
|
"name": "PostgrestResponse",
|
|
"variant": "declaration",
|
|
"kind": 2097152,
|
|
"flags": {},
|
|
"sources": [
|
|
{
|
|
"fileName": "packages/core/postgrest-js/src/types/types.ts",
|
|
"line": 33,
|
|
"character": 12,
|
|
"url": "https://github.com/supabase/supabase-js/blob/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L33"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 888,
|
|
"name": "T",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 904,
|
|
"typeArguments": [
|
|
{
|
|
"type": "array",
|
|
"elementType": {
|
|
"type": "reference",
|
|
"target": 888,
|
|
"name": "T",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
}
|
|
],
|
|
"name": "PostgrestSingleResponse",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
},
|
|
{
|
|
"id": 904,
|
|
"name": "PostgrestSingleResponse",
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/types/types.ts#L31"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 905,
|
|
"name": "T",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {}
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "union",
|
|
"types": [
|
|
{
|
|
"type": "reference",
|
|
"target": 896,
|
|
"typeArguments": [
|
|
{
|
|
"type": "reference",
|
|
"target": 905,
|
|
"name": "T",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
}
|
|
],
|
|
"name": "PostgrestResponseSuccess",
|
|
"package": "@supabase/postgrest-js"
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 889,
|
|
"name": "PostgrestResponseFailure",
|
|
"package": "@supabase/postgrest-js"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 911,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/select-query-parser/result.ts#L38"
|
|
}
|
|
],
|
|
"typeParameters": [
|
|
{
|
|
"id": 912,
|
|
"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": 913,
|
|
"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": 914,
|
|
"name": "RelationName",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "The name of the current table or view."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 915,
|
|
"name": "Relationships",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"comment": {
|
|
"summary": [
|
|
{
|
|
"kind": "text",
|
|
"text": "Relationships of the current table."
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"id": 916,
|
|
"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": 917,
|
|
"name": "ClientOptions",
|
|
"variant": "typeParam",
|
|
"kind": 131072,
|
|
"flags": {},
|
|
"type": {
|
|
"type": "reference",
|
|
"target": 908,
|
|
"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": 912,
|
|
"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": 916,
|
|
"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": 914,
|
|
"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": 915,
|
|
"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": 916,
|
|
"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": 914,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"trueType": {
|
|
"type": "reference",
|
|
"target": 914,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"falseType": {
|
|
"type": "literal",
|
|
"value": "rpc_call"
|
|
}
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 913,
|
|
"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": 913,
|
|
"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": 916,
|
|
"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": 914,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
"extendsType": {
|
|
"type": "intrinsic",
|
|
"name": "string"
|
|
},
|
|
"trueType": {
|
|
"type": "conditional",
|
|
"checkType": {
|
|
"type": "reference",
|
|
"target": 915,
|
|
"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": 917,
|
|
"name": "ClientOptions",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 912,
|
|
"name": "Schema",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 913,
|
|
"name": "Row",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 914,
|
|
"name": "RelationName",
|
|
"package": "@supabase/postgrest-js",
|
|
"refersToTypeParameter": true
|
|
},
|
|
{
|
|
"type": "reference",
|
|
"target": 915,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/index.ts#L21"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "query",
|
|
"queryType": {
|
|
"type": "reference",
|
|
"target": 774,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/index.ts#L22"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "query",
|
|
"queryType": {
|
|
"type": "reference",
|
|
"target": 867,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/index.ts#L19"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "query",
|
|
"queryType": {
|
|
"type": "reference",
|
|
"target": 186,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/index.ts#L18"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "query",
|
|
"queryType": {
|
|
"type": "reference",
|
|
"target": 81,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/index.ts#L20"
|
|
}
|
|
],
|
|
"type": {
|
|
"type": "query",
|
|
"queryType": {
|
|
"type": "reference",
|
|
"target": 604,
|
|
"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/ec39c4f09462d15b1e5991f6407963d933e00e2b/packages/core/postgrest-js/src/index.ts#L16"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"groups": [
|
|
{
|
|
"title": "Classes",
|
|
"children": [774, 9, 867, 186, 81, 604]
|
|
},
|
|
{
|
|
"title": "Interfaces",
|
|
"children": [889, 896]
|
|
},
|
|
{
|
|
"title": "Type Aliases",
|
|
"children": [908, 906, 887, 904, 911]
|
|
},
|
|
{
|
|
"title": "Variables",
|
|
"children": [1]
|
|
}
|
|
],
|
|
"packageName": "@supabase/postgrest-js",
|
|
"readme": [
|
|
{
|
|
"kind": "text",
|
|
"text": "<br />\n<p align=\"center\">\n <a href=\"https://supabase.io\">\n <picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--dark.svg\">\n <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/supabase-logo-wordmark--light.svg\">\n <img alt=\"Supabase Logo\" width=\"300\" src=\"https://raw.githubusercontent.com/supabase/supabase/master/packages/common/assets/images/logo-preview.jpg\">\n </picture>\n </a>\n\n <h1 align=\"center\">Supabase PostgREST JS SDK</h1>\n\n <h3 align=\"center\">Isomorphic JavaScript SDK for <a href=\"https://postgrest.org\">PostgREST</a> with an ORM-like interface.</h3>\n\n <p align=\"center\">\n <a href=\"https://supabase.com/docs/guides/database\">Guides</a>\n ·\n <a href=\"https://supabase.com/docs/reference/javascript/select\">Reference Docs</a>\n ·\n <a href=\"https://supabase.github.io/supabase-js/postgrest-js/v2/spec.json\">TypeDoc</a>\n </p>\n</p>\n\n<div align=\"center\">\n\n[](https://github.com/supabase/supabase-js/actions?query=branch%3Amaster)\n[](https://www.npmjs.com/package/@supabase/postgrest-js)\n[](#license)\n[](https://pkg.pr.new/~/supabase/postgrest-js)\n\n</div>\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)\npnpm nx build postgrest-js\n\n# Build with watch mode for development\npnpm nx build:watch postgrest-js\n\n# TypeScript type checking\npnpm nx type-check postgrest-js\n\n# Generate documentation\npnpm 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)\npnpm 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)\npnpm nx test:run postgrest-js\n\n# Run type tests with tstyche\npnpm nx test:types postgrest-js\n\n# Run smoke tests (CommonJS and ESM imports)\npnpm nx test:smoke postgrest-js\n\n# Format code\npnpm nx format postgrest-js\n\n# Check formatting\npnpm 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)\npnpm nx test:infra postgrest-js # Start containers\npnpm 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\npnpm 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": "`pnpm nx test:run postgrest-js`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ")\n- **Type Tests** - Validates TypeScript types using tstyche ("
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`pnpm nx test:types postgrest-js`"
|
|
},
|
|
{
|
|
"kind": "text",
|
|
"text": ")\n- **Smoke Tests** - Basic import/require tests for CommonJS and ESM ("
|
|
},
|
|
{
|
|
"kind": "code",
|
|
"text": "`pnpm 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)\npnpm 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\npnpm 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": "__type.retry"
|
|
},
|
|
"35": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.url"
|
|
},
|
|
"36": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.headers"
|
|
},
|
|
"37": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.schemaName"
|
|
},
|
|
"38": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.fetch"
|
|
},
|
|
"39": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"40": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"41": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"42": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"43": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"44": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"45": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"46": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.urlLengthLimit"
|
|
},
|
|
"47": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.retry"
|
|
},
|
|
"48": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.from"
|
|
},
|
|
"49": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.from"
|
|
},
|
|
"50": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "TableName"
|
|
},
|
|
"51": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "Table"
|
|
},
|
|
"52": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "relation"
|
|
},
|
|
"53": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.from"
|
|
},
|
|
"54": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "ViewName"
|
|
},
|
|
"55": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "View"
|
|
},
|
|
"56": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "relation"
|
|
},
|
|
"57": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.schema"
|
|
},
|
|
"58": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.schema"
|
|
},
|
|
"59": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "DynamicSchema"
|
|
},
|
|
"60": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "schema"
|
|
},
|
|
"61": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.rpc"
|
|
},
|
|
"62": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.rpc"
|
|
},
|
|
"63": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "FnName"
|
|
},
|
|
"64": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "Args"
|
|
},
|
|
"65": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "FilterBuilder"
|
|
},
|
|
"66": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "fn"
|
|
},
|
|
"67": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "args"
|
|
},
|
|
"68": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "__2"
|
|
},
|
|
"69": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"70": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "__type.head"
|
|
},
|
|
"71": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "__type.get"
|
|
},
|
|
"72": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "__type.count"
|
|
},
|
|
"73": {
|
|
"sourceFileName": "",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"74": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.Database"
|
|
},
|
|
"75": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.ClientOptions"
|
|
},
|
|
"76": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"77": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "__type.__InternalSupabase"
|
|
},
|
|
"78": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"79": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.SchemaName"
|
|
},
|
|
"80": {
|
|
"sourceFileName": "src/PostgrestClient.ts",
|
|
"qualifiedName": "default.Schema"
|
|
},
|
|
"81": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"82": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.__constructor"
|
|
},
|
|
"83": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"84": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.ClientOptions"
|
|
},
|
|
"85": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.Schema"
|
|
},
|
|
"86": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.Relation"
|
|
},
|
|
"87": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.RelationName"
|
|
},
|
|
"88": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.Relationships"
|
|
},
|
|
"89": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"90": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.Relationships"
|
|
},
|
|
"91": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "url"
|
|
},
|
|
"92": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__1"
|
|
},
|
|
"93": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"94": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.headers"
|
|
},
|
|
"95": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.schema"
|
|
},
|
|
"96": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.fetch"
|
|
},
|
|
"97": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"98": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"99": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"100": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"101": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"102": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"103": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"104": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.urlLengthLimit"
|
|
},
|
|
"105": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.retry"
|
|
},
|
|
"106": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.url"
|
|
},
|
|
"107": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.headers"
|
|
},
|
|
"108": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.schema"
|
|
},
|
|
"109": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.signal"
|
|
},
|
|
"110": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.fetch"
|
|
},
|
|
"111": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"112": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"113": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"114": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"115": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"116": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"117": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"118": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.urlLengthLimit"
|
|
},
|
|
"119": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.retry"
|
|
},
|
|
"125": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.select"
|
|
},
|
|
"126": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.select"
|
|
},
|
|
"127": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "Query"
|
|
},
|
|
"128": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "ResultOne"
|
|
},
|
|
"129": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "columns"
|
|
},
|
|
"130": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"131": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"132": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.head"
|
|
},
|
|
"133": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.count"
|
|
},
|
|
"134": {
|
|
"sourceFileName": "",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"135": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.insert"
|
|
},
|
|
"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": "__type"
|
|
},
|
|
"140": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.Insert"
|
|
},
|
|
"141": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"142": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.Insert"
|
|
},
|
|
"143": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__1"
|
|
},
|
|
"144": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"145": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.count"
|
|
},
|
|
"146": {
|
|
"sourceFileName": "",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"147": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.defaultToNull"
|
|
},
|
|
"148": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.upsert"
|
|
},
|
|
"149": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.upsert"
|
|
},
|
|
"150": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "Row"
|
|
},
|
|
"151": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "values"
|
|
},
|
|
"152": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"153": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.Insert"
|
|
},
|
|
"154": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"155": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.Insert"
|
|
},
|
|
"156": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__1"
|
|
},
|
|
"157": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"158": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.onConflict"
|
|
},
|
|
"159": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.ignoreDuplicates"
|
|
},
|
|
"160": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.count"
|
|
},
|
|
"161": {
|
|
"sourceFileName": "",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"162": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.defaultToNull"
|
|
},
|
|
"163": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.update"
|
|
},
|
|
"164": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.update"
|
|
},
|
|
"165": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "Row"
|
|
},
|
|
"166": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "values"
|
|
},
|
|
"167": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"168": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.Update"
|
|
},
|
|
"169": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__1"
|
|
},
|
|
"170": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"171": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.count"
|
|
},
|
|
"172": {
|
|
"sourceFileName": "",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"173": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.delete"
|
|
},
|
|
"174": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.delete"
|
|
},
|
|
"175": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__0"
|
|
},
|
|
"176": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"177": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.count"
|
|
},
|
|
"178": {
|
|
"sourceFileName": "",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"179": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.ClientOptions"
|
|
},
|
|
"180": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.Schema"
|
|
},
|
|
"181": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.Relation"
|
|
},
|
|
"182": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.RelationName"
|
|
},
|
|
"183": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "default.Relationships"
|
|
},
|
|
"184": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"185": {
|
|
"sourceFileName": "src/PostgrestQueryBuilder.ts",
|
|
"qualifiedName": "__type.Relationships"
|
|
},
|
|
"186": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"187": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.__constructor"
|
|
},
|
|
"188": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"189": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.ClientOptions"
|
|
},
|
|
"190": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.Schema"
|
|
},
|
|
"191": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.Row"
|
|
},
|
|
"192": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.Result"
|
|
},
|
|
"193": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.RelationName"
|
|
},
|
|
"194": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.Relationships"
|
|
},
|
|
"195": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.Method"
|
|
},
|
|
"196": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "builder"
|
|
},
|
|
"197": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"198": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.method"
|
|
},
|
|
"199": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.url"
|
|
},
|
|
"200": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.headers"
|
|
},
|
|
"201": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.schema"
|
|
},
|
|
"202": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.body"
|
|
},
|
|
"203": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.shouldThrowOnError"
|
|
},
|
|
"204": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.signal"
|
|
},
|
|
"205": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.fetch"
|
|
},
|
|
"206": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"207": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"208": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"209": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"210": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"211": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"212": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"213": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.isMaybeSingle"
|
|
},
|
|
"214": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.shouldStripNulls"
|
|
},
|
|
"215": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.urlLengthLimit"
|
|
},
|
|
"216": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.retry"
|
|
},
|
|
"217": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.eq"
|
|
},
|
|
"218": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.eq"
|
|
},
|
|
"219": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"220": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"221": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"222": {
|
|
"sourceFileName": "",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"223": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.neq"
|
|
},
|
|
"224": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.neq"
|
|
},
|
|
"225": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"226": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"227": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"228": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.gt"
|
|
},
|
|
"229": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.gt"
|
|
},
|
|
"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.gt"
|
|
},
|
|
"234": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"235": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"236": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.gte"
|
|
},
|
|
"237": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.gte"
|
|
},
|
|
"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.gte"
|
|
},
|
|
"242": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"243": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"244": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.lt"
|
|
},
|
|
"245": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.lt"
|
|
},
|
|
"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.lt"
|
|
},
|
|
"250": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"251": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"252": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.lte"
|
|
},
|
|
"253": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.lte"
|
|
},
|
|
"254": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"255": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"256": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"257": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.lte"
|
|
},
|
|
"258": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"259": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"260": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.like"
|
|
},
|
|
"261": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.like"
|
|
},
|
|
"262": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"263": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"264": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "pattern"
|
|
},
|
|
"265": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.like"
|
|
},
|
|
"266": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"267": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "pattern"
|
|
},
|
|
"268": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.likeAllOf"
|
|
},
|
|
"269": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.likeAllOf"
|
|
},
|
|
"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.likeAllOf"
|
|
},
|
|
"274": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"275": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "patterns"
|
|
},
|
|
"276": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.likeAnyOf"
|
|
},
|
|
"277": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.likeAnyOf"
|
|
},
|
|
"278": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"279": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"280": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "patterns"
|
|
},
|
|
"281": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.likeAnyOf"
|
|
},
|
|
"282": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"283": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "patterns"
|
|
},
|
|
"284": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.ilike"
|
|
},
|
|
"285": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.ilike"
|
|
},
|
|
"286": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"287": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"288": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "pattern"
|
|
},
|
|
"289": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.ilike"
|
|
},
|
|
"290": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"291": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "pattern"
|
|
},
|
|
"292": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.ilikeAllOf"
|
|
},
|
|
"293": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.ilikeAllOf"
|
|
},
|
|
"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.ilikeAllOf"
|
|
},
|
|
"298": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"299": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "patterns"
|
|
},
|
|
"300": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.ilikeAnyOf"
|
|
},
|
|
"301": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.ilikeAnyOf"
|
|
},
|
|
"302": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"303": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"304": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "patterns"
|
|
},
|
|
"305": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.ilikeAnyOf"
|
|
},
|
|
"306": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"307": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "patterns"
|
|
},
|
|
"308": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.regexMatch"
|
|
},
|
|
"309": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.regexMatch"
|
|
},
|
|
"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.regexMatch"
|
|
},
|
|
"314": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"315": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "pattern"
|
|
},
|
|
"316": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.regexIMatch"
|
|
},
|
|
"317": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.regexIMatch"
|
|
},
|
|
"318": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"319": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"320": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "pattern"
|
|
},
|
|
"321": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.regexIMatch"
|
|
},
|
|
"322": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"323": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "pattern"
|
|
},
|
|
"324": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.is"
|
|
},
|
|
"325": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.is"
|
|
},
|
|
"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.is"
|
|
},
|
|
"330": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"331": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"332": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.isDistinct"
|
|
},
|
|
"333": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.isDistinct"
|
|
},
|
|
"334": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"335": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"336": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"337": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.in"
|
|
},
|
|
"338": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.in"
|
|
},
|
|
"339": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"340": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"341": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "values"
|
|
},
|
|
"342": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.notIn"
|
|
},
|
|
"343": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.notIn"
|
|
},
|
|
"344": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"345": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"346": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "values"
|
|
},
|
|
"347": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.contains"
|
|
},
|
|
"348": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.contains"
|
|
},
|
|
"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.contains"
|
|
},
|
|
"353": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"354": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"355": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.containedBy"
|
|
},
|
|
"356": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.containedBy"
|
|
},
|
|
"357": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"358": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"359": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"360": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.containedBy"
|
|
},
|
|
"361": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"362": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"363": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.rangeGt"
|
|
},
|
|
"364": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.rangeGt"
|
|
},
|
|
"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.rangeGt"
|
|
},
|
|
"369": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"370": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "range"
|
|
},
|
|
"371": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.rangeGte"
|
|
},
|
|
"372": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.rangeGte"
|
|
},
|
|
"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.rangeGte"
|
|
},
|
|
"377": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"378": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "range"
|
|
},
|
|
"379": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.rangeLt"
|
|
},
|
|
"380": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.rangeLt"
|
|
},
|
|
"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.rangeLt"
|
|
},
|
|
"385": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"386": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "range"
|
|
},
|
|
"387": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.rangeLte"
|
|
},
|
|
"388": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.rangeLte"
|
|
},
|
|
"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.rangeLte"
|
|
},
|
|
"393": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"394": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "range"
|
|
},
|
|
"395": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.rangeAdjacent"
|
|
},
|
|
"396": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.rangeAdjacent"
|
|
},
|
|
"397": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"398": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"399": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "range"
|
|
},
|
|
"400": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.rangeAdjacent"
|
|
},
|
|
"401": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"402": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "range"
|
|
},
|
|
"403": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.overlaps"
|
|
},
|
|
"404": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.overlaps"
|
|
},
|
|
"405": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"406": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"407": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"408": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.overlaps"
|
|
},
|
|
"409": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"410": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"411": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.textSearch"
|
|
},
|
|
"412": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.textSearch"
|
|
},
|
|
"413": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"414": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"415": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "query"
|
|
},
|
|
"416": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"417": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"418": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "__type.config"
|
|
},
|
|
"419": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "__type.type"
|
|
},
|
|
"420": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.textSearch"
|
|
},
|
|
"421": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"422": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "query"
|
|
},
|
|
"423": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"424": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"425": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "__type.config"
|
|
},
|
|
"426": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "__type.type"
|
|
},
|
|
"427": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.match"
|
|
},
|
|
"428": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.match"
|
|
},
|
|
"429": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"430": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "query"
|
|
},
|
|
"431": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.match"
|
|
},
|
|
"432": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "query"
|
|
},
|
|
"433": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.not"
|
|
},
|
|
"434": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.not"
|
|
},
|
|
"435": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"436": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"437": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "operator"
|
|
},
|
|
"438": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"439": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.not"
|
|
},
|
|
"440": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"441": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"442": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "operator"
|
|
},
|
|
"443": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"444": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.not"
|
|
},
|
|
"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.or"
|
|
},
|
|
"449": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.or"
|
|
},
|
|
"450": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "filters"
|
|
},
|
|
"451": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "__1"
|
|
},
|
|
"452": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"453": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "__type.foreignTable"
|
|
},
|
|
"454": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "__type.referencedTable"
|
|
},
|
|
"455": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.filter"
|
|
},
|
|
"456": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.filter"
|
|
},
|
|
"457": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"458": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"459": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "operator"
|
|
},
|
|
"460": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"461": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.filter"
|
|
},
|
|
"462": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"463": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "operator"
|
|
},
|
|
"464": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"465": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.select"
|
|
},
|
|
"466": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.select"
|
|
},
|
|
"467": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "Query"
|
|
},
|
|
"468": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "NewResultOne"
|
|
},
|
|
"469": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "columns"
|
|
},
|
|
"470": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.order"
|
|
},
|
|
"471": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.order"
|
|
},
|
|
"472": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"473": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"474": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"475": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"476": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.ascending"
|
|
},
|
|
"477": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.nullsFirst"
|
|
},
|
|
"478": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.referencedTable"
|
|
},
|
|
"479": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.order"
|
|
},
|
|
"480": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"481": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"482": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"483": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.ascending"
|
|
},
|
|
"484": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.nullsFirst"
|
|
},
|
|
"485": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.referencedTable"
|
|
},
|
|
"486": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.order"
|
|
},
|
|
"487": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"488": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"489": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"490": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"491": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.ascending"
|
|
},
|
|
"492": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.nullsFirst"
|
|
},
|
|
"493": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.foreignTable"
|
|
},
|
|
"494": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.order"
|
|
},
|
|
"495": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"496": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"497": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"498": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.ascending"
|
|
},
|
|
"499": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.nullsFirst"
|
|
},
|
|
"500": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.foreignTable"
|
|
},
|
|
"501": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.limit"
|
|
},
|
|
"502": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.limit"
|
|
},
|
|
"503": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "count"
|
|
},
|
|
"504": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__1"
|
|
},
|
|
"505": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"506": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.foreignTable"
|
|
},
|
|
"507": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.referencedTable"
|
|
},
|
|
"508": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.range"
|
|
},
|
|
"509": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.range"
|
|
},
|
|
"510": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "from"
|
|
},
|
|
"511": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "to"
|
|
},
|
|
"512": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__2"
|
|
},
|
|
"513": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"514": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.foreignTable"
|
|
},
|
|
"515": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.referencedTable"
|
|
},
|
|
"516": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.abortSignal"
|
|
},
|
|
"517": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.abortSignal"
|
|
},
|
|
"518": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "signal"
|
|
},
|
|
"519": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.single"
|
|
},
|
|
"520": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.single"
|
|
},
|
|
"521": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "ResultOne"
|
|
},
|
|
"522": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.maybeSingle"
|
|
},
|
|
"523": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.maybeSingle"
|
|
},
|
|
"524": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "ResultOne"
|
|
},
|
|
"525": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.csv"
|
|
},
|
|
"526": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.csv"
|
|
},
|
|
"527": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.geojson"
|
|
},
|
|
"528": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.geojson"
|
|
},
|
|
"529": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.explain"
|
|
},
|
|
"530": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.explain"
|
|
},
|
|
"531": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__0"
|
|
},
|
|
"532": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"533": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.analyze"
|
|
},
|
|
"534": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.verbose"
|
|
},
|
|
"535": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.settings"
|
|
},
|
|
"536": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.buffers"
|
|
},
|
|
"537": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.wal"
|
|
},
|
|
"538": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.format"
|
|
},
|
|
"539": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.rollback"
|
|
},
|
|
"540": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.rollback"
|
|
},
|
|
"541": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.returns"
|
|
},
|
|
"542": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.returns"
|
|
},
|
|
"543": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "NewResult"
|
|
},
|
|
"544": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.maxAffected"
|
|
},
|
|
"545": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.maxAffected"
|
|
},
|
|
"546": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"547": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.method"
|
|
},
|
|
"548": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.url"
|
|
},
|
|
"549": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.headers"
|
|
},
|
|
"550": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.schema"
|
|
},
|
|
"551": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.body"
|
|
},
|
|
"552": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.shouldThrowOnError"
|
|
},
|
|
"553": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.signal"
|
|
},
|
|
"554": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.fetch"
|
|
},
|
|
"555": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"556": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"557": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"558": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"559": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"560": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"561": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"562": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.isMaybeSingle"
|
|
},
|
|
"563": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.shouldStripNulls"
|
|
},
|
|
"564": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.urlLengthLimit"
|
|
},
|
|
"565": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.retryEnabled"
|
|
},
|
|
"566": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"567": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"568": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.stripNulls"
|
|
},
|
|
"569": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.stripNulls"
|
|
},
|
|
"570": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"571": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"572": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "name"
|
|
},
|
|
"573": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"574": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.retry"
|
|
},
|
|
"575": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.retry"
|
|
},
|
|
"576": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "enabled"
|
|
},
|
|
"577": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"578": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"579": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "TResult1"
|
|
},
|
|
"580": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "TResult2"
|
|
},
|
|
"581": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "onfulfilled"
|
|
},
|
|
"582": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"583": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"584": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"585": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "onrejected"
|
|
},
|
|
"586": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"587": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"588": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "reason"
|
|
},
|
|
"589": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.overrideTypes"
|
|
},
|
|
"590": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.overrideTypes"
|
|
},
|
|
"591": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "NewResult"
|
|
},
|
|
"592": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "Options"
|
|
},
|
|
"593": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"594": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.merge"
|
|
},
|
|
"595": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"596": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.merge"
|
|
},
|
|
"597": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.ClientOptions"
|
|
},
|
|
"598": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.Schema"
|
|
},
|
|
"599": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.Row"
|
|
},
|
|
"600": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.Result"
|
|
},
|
|
"601": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.RelationName"
|
|
},
|
|
"602": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.Relationships"
|
|
},
|
|
"603": {
|
|
"sourceFileName": "src/PostgrestFilterBuilder.ts",
|
|
"qualifiedName": "default.Method"
|
|
},
|
|
"604": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"605": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.__constructor"
|
|
},
|
|
"606": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"607": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.ClientOptions"
|
|
},
|
|
"608": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.Schema"
|
|
},
|
|
"609": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.Row"
|
|
},
|
|
"610": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.Result"
|
|
},
|
|
"611": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.RelationName"
|
|
},
|
|
"612": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.Relationships"
|
|
},
|
|
"613": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.Method"
|
|
},
|
|
"614": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "builder"
|
|
},
|
|
"615": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"616": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.method"
|
|
},
|
|
"617": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.url"
|
|
},
|
|
"618": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.headers"
|
|
},
|
|
"619": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.schema"
|
|
},
|
|
"620": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.body"
|
|
},
|
|
"621": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.shouldThrowOnError"
|
|
},
|
|
"622": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.signal"
|
|
},
|
|
"623": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.fetch"
|
|
},
|
|
"624": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"625": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"626": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"627": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"628": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"629": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"630": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"631": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.isMaybeSingle"
|
|
},
|
|
"632": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.shouldStripNulls"
|
|
},
|
|
"633": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.urlLengthLimit"
|
|
},
|
|
"634": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.retry"
|
|
},
|
|
"635": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.select"
|
|
},
|
|
"636": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.select"
|
|
},
|
|
"637": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "Query"
|
|
},
|
|
"638": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "NewResultOne"
|
|
},
|
|
"639": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "columns"
|
|
},
|
|
"640": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.order"
|
|
},
|
|
"641": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.order"
|
|
},
|
|
"642": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"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.referencedTable"
|
|
},
|
|
"649": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.order"
|
|
},
|
|
"650": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"651": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"652": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"653": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.ascending"
|
|
},
|
|
"654": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.nullsFirst"
|
|
},
|
|
"655": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.referencedTable"
|
|
},
|
|
"656": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.order"
|
|
},
|
|
"657": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "ColumnName"
|
|
},
|
|
"658": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"659": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"660": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"661": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.ascending"
|
|
},
|
|
"662": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.nullsFirst"
|
|
},
|
|
"663": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.foreignTable"
|
|
},
|
|
"664": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.order"
|
|
},
|
|
"665": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "column"
|
|
},
|
|
"666": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "options"
|
|
},
|
|
"667": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"668": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.ascending"
|
|
},
|
|
"669": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.nullsFirst"
|
|
},
|
|
"670": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.foreignTable"
|
|
},
|
|
"671": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.limit"
|
|
},
|
|
"672": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.limit"
|
|
},
|
|
"673": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "count"
|
|
},
|
|
"674": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__1"
|
|
},
|
|
"675": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"676": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.foreignTable"
|
|
},
|
|
"677": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.referencedTable"
|
|
},
|
|
"678": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.range"
|
|
},
|
|
"679": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.range"
|
|
},
|
|
"680": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "from"
|
|
},
|
|
"681": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "to"
|
|
},
|
|
"682": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__2"
|
|
},
|
|
"683": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"684": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.foreignTable"
|
|
},
|
|
"685": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.referencedTable"
|
|
},
|
|
"686": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.abortSignal"
|
|
},
|
|
"687": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.abortSignal"
|
|
},
|
|
"688": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "signal"
|
|
},
|
|
"689": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.single"
|
|
},
|
|
"690": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.single"
|
|
},
|
|
"691": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "ResultOne"
|
|
},
|
|
"692": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.maybeSingle"
|
|
},
|
|
"693": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.maybeSingle"
|
|
},
|
|
"694": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "ResultOne"
|
|
},
|
|
"695": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.csv"
|
|
},
|
|
"696": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.csv"
|
|
},
|
|
"697": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.geojson"
|
|
},
|
|
"698": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.geojson"
|
|
},
|
|
"699": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.explain"
|
|
},
|
|
"700": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.explain"
|
|
},
|
|
"701": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__0"
|
|
},
|
|
"702": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"703": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.analyze"
|
|
},
|
|
"704": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.verbose"
|
|
},
|
|
"705": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.settings"
|
|
},
|
|
"706": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.buffers"
|
|
},
|
|
"707": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.wal"
|
|
},
|
|
"708": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "__type.format"
|
|
},
|
|
"709": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.rollback"
|
|
},
|
|
"710": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.rollback"
|
|
},
|
|
"711": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.returns"
|
|
},
|
|
"712": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.returns"
|
|
},
|
|
"713": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "NewResult"
|
|
},
|
|
"714": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.maxAffected"
|
|
},
|
|
"715": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.maxAffected"
|
|
},
|
|
"716": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"717": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.method"
|
|
},
|
|
"718": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.url"
|
|
},
|
|
"719": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.headers"
|
|
},
|
|
"720": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.schema"
|
|
},
|
|
"721": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.body"
|
|
},
|
|
"722": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.shouldThrowOnError"
|
|
},
|
|
"723": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.signal"
|
|
},
|
|
"724": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.fetch"
|
|
},
|
|
"725": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"726": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"727": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"728": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"729": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"730": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"731": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"732": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.isMaybeSingle"
|
|
},
|
|
"733": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.shouldStripNulls"
|
|
},
|
|
"734": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.urlLengthLimit"
|
|
},
|
|
"735": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.retryEnabled"
|
|
},
|
|
"736": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"737": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"738": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.stripNulls"
|
|
},
|
|
"739": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.stripNulls"
|
|
},
|
|
"740": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"741": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"742": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "name"
|
|
},
|
|
"743": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"744": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.retry"
|
|
},
|
|
"745": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.retry"
|
|
},
|
|
"746": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "enabled"
|
|
},
|
|
"747": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"748": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"749": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "TResult1"
|
|
},
|
|
"750": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "TResult2"
|
|
},
|
|
"751": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "onfulfilled"
|
|
},
|
|
"752": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"753": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"754": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"755": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "onrejected"
|
|
},
|
|
"756": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"757": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"758": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "reason"
|
|
},
|
|
"759": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.overrideTypes"
|
|
},
|
|
"760": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.overrideTypes"
|
|
},
|
|
"761": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "NewResult"
|
|
},
|
|
"762": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "Options"
|
|
},
|
|
"763": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"764": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.merge"
|
|
},
|
|
"765": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"766": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.merge"
|
|
},
|
|
"767": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.ClientOptions"
|
|
},
|
|
"768": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.Schema"
|
|
},
|
|
"769": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.Row"
|
|
},
|
|
"770": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.Result"
|
|
},
|
|
"771": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.RelationName"
|
|
},
|
|
"772": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.Relationships"
|
|
},
|
|
"773": {
|
|
"sourceFileName": "src/PostgrestTransformBuilder.ts",
|
|
"qualifiedName": "default.Method"
|
|
},
|
|
"774": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"775": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.__constructor"
|
|
},
|
|
"776": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"777": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.ClientOptions"
|
|
},
|
|
"778": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.Result"
|
|
},
|
|
"779": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.ThrowOnError"
|
|
},
|
|
"780": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "builder"
|
|
},
|
|
"781": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"782": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.method"
|
|
},
|
|
"783": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.url"
|
|
},
|
|
"784": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.headers"
|
|
},
|
|
"785": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.schema"
|
|
},
|
|
"786": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.body"
|
|
},
|
|
"787": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.shouldThrowOnError"
|
|
},
|
|
"788": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.signal"
|
|
},
|
|
"789": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.fetch"
|
|
},
|
|
"790": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"791": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"792": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"793": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"794": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"795": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"796": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"797": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.isMaybeSingle"
|
|
},
|
|
"798": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.shouldStripNulls"
|
|
},
|
|
"799": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.urlLengthLimit"
|
|
},
|
|
"800": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.retry"
|
|
},
|
|
"801": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.method"
|
|
},
|
|
"802": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.url"
|
|
},
|
|
"803": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.headers"
|
|
},
|
|
"804": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.schema"
|
|
},
|
|
"805": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.body"
|
|
},
|
|
"806": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.shouldThrowOnError"
|
|
},
|
|
"807": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.signal"
|
|
},
|
|
"808": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.fetch"
|
|
},
|
|
"809": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"810": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"811": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"812": {
|
|
"sourceFileName": "../../../node_modules/typescript/lib/lib.dom.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"813": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "fetch"
|
|
},
|
|
"814": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "input"
|
|
},
|
|
"815": {
|
|
"sourceFileName": "../../../node_modules/@types/node/globals.d.ts",
|
|
"qualifiedName": "init"
|
|
},
|
|
"816": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.isMaybeSingle"
|
|
},
|
|
"817": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.shouldStripNulls"
|
|
},
|
|
"818": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.urlLengthLimit"
|
|
},
|
|
"819": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.retryEnabled"
|
|
},
|
|
"820": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"821": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.throwOnError"
|
|
},
|
|
"822": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.stripNulls"
|
|
},
|
|
"823": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.stripNulls"
|
|
},
|
|
"824": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"825": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.setHeader"
|
|
},
|
|
"826": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "name"
|
|
},
|
|
"827": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"828": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.retry"
|
|
},
|
|
"829": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.retry"
|
|
},
|
|
"830": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "enabled"
|
|
},
|
|
"831": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"832": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.then"
|
|
},
|
|
"833": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "TResult1"
|
|
},
|
|
"834": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "TResult2"
|
|
},
|
|
"835": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "onfulfilled"
|
|
},
|
|
"836": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"837": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"838": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "value"
|
|
},
|
|
"839": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "onrejected"
|
|
},
|
|
"840": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"841": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"842": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "reason"
|
|
},
|
|
"853": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.returns"
|
|
},
|
|
"854": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.returns"
|
|
},
|
|
"855": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "NewResult"
|
|
},
|
|
"856": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.overrideTypes"
|
|
},
|
|
"857": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.overrideTypes"
|
|
},
|
|
"858": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "NewResult"
|
|
},
|
|
"859": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "Options"
|
|
},
|
|
"860": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"861": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.merge"
|
|
},
|
|
"862": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"863": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "__type.merge"
|
|
},
|
|
"864": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.ClientOptions"
|
|
},
|
|
"865": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.Result"
|
|
},
|
|
"866": {
|
|
"sourceFileName": "src/PostgrestBuilder.ts",
|
|
"qualifiedName": "default.ThrowOnError"
|
|
},
|
|
"867": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"868": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "default.__constructor"
|
|
},
|
|
"869": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "default"
|
|
},
|
|
"870": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "context"
|
|
},
|
|
"871": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"872": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"873": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "__type.details"
|
|
},
|
|
"874": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "__type.hint"
|
|
},
|
|
"875": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "__type.code"
|
|
},
|
|
"876": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "default.details"
|
|
},
|
|
"877": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "default.hint"
|
|
},
|
|
"878": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "default.code"
|
|
},
|
|
"879": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "default.toJSON"
|
|
},
|
|
"880": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "default.toJSON"
|
|
},
|
|
"881": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"882": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "__type.name"
|
|
},
|
|
"883": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "__type.message"
|
|
},
|
|
"884": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "__type.details"
|
|
},
|
|
"885": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "__type.hint"
|
|
},
|
|
"886": {
|
|
"sourceFileName": "src/PostgrestError.ts",
|
|
"qualifiedName": "__type.code"
|
|
},
|
|
"887": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponse"
|
|
},
|
|
"888": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "T"
|
|
},
|
|
"889": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseFailure"
|
|
},
|
|
"890": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseFailure.success"
|
|
},
|
|
"891": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseFailure.error"
|
|
},
|
|
"892": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseFailure.data"
|
|
},
|
|
"893": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseFailure.count"
|
|
},
|
|
"894": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseBase.status"
|
|
},
|
|
"895": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseBase.statusText"
|
|
},
|
|
"896": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseSuccess"
|
|
},
|
|
"897": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseSuccess.success"
|
|
},
|
|
"898": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseSuccess.error"
|
|
},
|
|
"899": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseSuccess.data"
|
|
},
|
|
"900": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseSuccess.count"
|
|
},
|
|
"901": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseBase.status"
|
|
},
|
|
"902": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseBase.statusText"
|
|
},
|
|
"903": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestResponseSuccess.T"
|
|
},
|
|
"904": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestSingleResponse"
|
|
},
|
|
"905": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "T"
|
|
},
|
|
"906": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "PostgrestMaybeSingleResponse"
|
|
},
|
|
"907": {
|
|
"sourceFileName": "src/types/types.ts",
|
|
"qualifiedName": "T"
|
|
},
|
|
"908": {
|
|
"sourceFileName": "src/types/common/common.ts",
|
|
"qualifiedName": "ClientServerOptions"
|
|
},
|
|
"909": {
|
|
"sourceFileName": "src/types/common/common.ts",
|
|
"qualifiedName": "__type"
|
|
},
|
|
"910": {
|
|
"sourceFileName": "src/types/common/common.ts",
|
|
"qualifiedName": "__type.PostgrestVersion"
|
|
},
|
|
"911": {
|
|
"sourceFileName": "src/select-query-parser/result.ts",
|
|
"qualifiedName": "GetResult"
|
|
},
|
|
"912": {
|
|
"sourceFileName": "src/select-query-parser/result.ts",
|
|
"qualifiedName": "Schema"
|
|
},
|
|
"913": {
|
|
"sourceFileName": "src/select-query-parser/result.ts",
|
|
"qualifiedName": "Row"
|
|
},
|
|
"914": {
|
|
"sourceFileName": "src/select-query-parser/result.ts",
|
|
"qualifiedName": "RelationName"
|
|
},
|
|
"915": {
|
|
"sourceFileName": "src/select-query-parser/result.ts",
|
|
"qualifiedName": "Relationships"
|
|
},
|
|
"916": {
|
|
"sourceFileName": "src/select-query-parser/result.ts",
|
|
"qualifiedName": "Query"
|
|
},
|
|
"917": {
|
|
"sourceFileName": "src/select-query-parser/result.ts",
|
|
"qualifiedName": "ClientOptions"
|
|
}
|
|
},
|
|
"files": {
|
|
"entries": {
|
|
"1": "src/index.ts",
|
|
"2": "../../../CONTRIBUTING.md"
|
|
},
|
|
"reflections": {
|
|
"1": 0
|
|
}
|
|
}
|
|
}
|