mirror of
https://github.com/supabase/supabase.git
synced 2026-10-12 21:05:06 +03:00
1915 lines
52 KiB
JSON
1915 lines
52 KiB
JSON
[
|
|
{
|
|
"title": "Introduction",
|
|
"id": "introduction",
|
|
"slug": "introduction",
|
|
"type": "markdown"
|
|
},
|
|
{
|
|
"title": "Installing",
|
|
"id": "installing",
|
|
"slug": "installing",
|
|
"type": "markdown",
|
|
"excludes": ["reference_javascript_v1", "reference_kotlin_v1", "reference_swift_v1"]
|
|
},
|
|
{
|
|
"title": "Initializing",
|
|
"id": "initializing",
|
|
"slug": "initializing",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"title": "TypeScript support",
|
|
"id": "typescript-support",
|
|
"slug": "typescript-support",
|
|
"type": "markdown",
|
|
"excludes": [
|
|
"reference_javascript_v1",
|
|
"reference_dart_v1",
|
|
"reference_dart_v2",
|
|
"reference_python_v2",
|
|
"reference_csharp_v0",
|
|
"reference_csharp_v1",
|
|
"reference_swift_v1",
|
|
"reference_swift_v2",
|
|
"reference_kotlin_v1",
|
|
"reference_kotlin_v2",
|
|
"reference_kotlin_v3"
|
|
]
|
|
},
|
|
{
|
|
"title": "Upgrade guide",
|
|
"id": "upgrade-guide",
|
|
"slug": "upgrade-guide",
|
|
"type": "markdown",
|
|
"excludes": [
|
|
"reference_javascript_v2",
|
|
"reference_dart_v1",
|
|
"reference_python_v2",
|
|
"reference_csharp_v0",
|
|
"reference_csharp_v1",
|
|
"reference_swift_v1",
|
|
"reference_swift_v2",
|
|
"reference_kotlin_v1",
|
|
"reference_kotlin_v2",
|
|
"reference_kotlin_v3"
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Database",
|
|
"items": [
|
|
{
|
|
"id": "select",
|
|
"title": "Fetch data",
|
|
"slug": "select",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "insert",
|
|
"title": "Insert data",
|
|
"slug": "insert",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "update",
|
|
"title": "Update data",
|
|
"slug": "update",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "upsert",
|
|
"title": "Upsert data",
|
|
"slug": "upsert",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "delete",
|
|
"title": "Delete data",
|
|
"slug": "delete",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "rpc",
|
|
"title": "Call a Postgres function",
|
|
"slug": "rpc",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "using-filters",
|
|
"isFunc": false,
|
|
"title": "Using filters",
|
|
"slug": "using-filters",
|
|
"product": "database",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "eq",
|
|
"title": "Column is equal to a value",
|
|
"slug": "eq",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "neq",
|
|
"title": "Column is not equal to a value",
|
|
"slug": "neq",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "gt",
|
|
"title": "Column is greater than a value",
|
|
"slug": "gt",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "gte",
|
|
"title": "Column is greater than or equal to a value",
|
|
"slug": "gte",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "lt",
|
|
"title": "Column is less than a value",
|
|
"slug": "lt",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "lte",
|
|
"title": "Column is less than or equal to a value",
|
|
"slug": "lte",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "like",
|
|
"title": "Column matches a pattern",
|
|
"slug": "like",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "ilike",
|
|
"title": "Column matches a case-insensitive pattern",
|
|
"slug": "ilike",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "ilikeallof",
|
|
"title": "Match all patterns case-insensitively",
|
|
"slug": "ilikeallof",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "ilikeanyof",
|
|
"title": "Match any pattern case-insensitively",
|
|
"slug": "ilikeanyof",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "likeallof",
|
|
"title": "Match all patterns case-sensitively",
|
|
"slug": "likeallof",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "likeanyof",
|
|
"title": "Match any pattern case-sensitively",
|
|
"slug": "likeanyof",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "is",
|
|
"title": "Column is a value",
|
|
"slug": "is",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "in",
|
|
"title": "Column is in an array",
|
|
"slug": "in",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "contains",
|
|
"title": "Column contains every element in a value",
|
|
"slug": "contains",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "contained-by",
|
|
"title": "Contained by value",
|
|
"slug": "containedby",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range-gt",
|
|
"title": "Greater than a range",
|
|
"slug": "rangegt",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range-gte",
|
|
"title": "Greater than or equal to a range",
|
|
"slug": "rangegte",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range-lt",
|
|
"title": "Less than a range",
|
|
"slug": "rangelt",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range-lte",
|
|
"title": "Less than or equal to a range",
|
|
"slug": "rangelte",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range-adjacent",
|
|
"title": "Mutually exclusive to a range",
|
|
"slug": "rangeadjacent",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "overlaps",
|
|
"title": "With a common element",
|
|
"slug": "overlaps",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "text-search",
|
|
"title": "Match a string",
|
|
"slug": "textsearch",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "match",
|
|
"title": "Match an associated value",
|
|
"slug": "match",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "not",
|
|
"title": "Don't match the filter",
|
|
"slug": "not",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "or",
|
|
"title": "Match at least one filter",
|
|
"slug": "or",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "filter",
|
|
"title": "Match the filter",
|
|
"slug": "filter",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "geojson",
|
|
"title": "Return data as GeoJSON",
|
|
"slug": "geojson",
|
|
"product": "database",
|
|
"parent": "filters",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create a query builder instance",
|
|
"slug": "constructor",
|
|
"product": "database",
|
|
"type": "function",
|
|
"parent": "filters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "using-modifiers",
|
|
"isFunc": false,
|
|
"title": "Using modifiers",
|
|
"slug": "using-modifiers",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "db-modifiers-select",
|
|
"title": "Return data after inserting",
|
|
"slug": "db-modifiers-select",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "order",
|
|
"title": "Order the results",
|
|
"slug": "order",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "limit",
|
|
"title": "Limit the number of rows returned",
|
|
"slug": "limit",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "range",
|
|
"title": "Limit the query to a range",
|
|
"slug": "range",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "abort-signal",
|
|
"title": "Set an abort signal",
|
|
"slug": "db-abortsignal",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "single",
|
|
"title": "Retrieve one row of data",
|
|
"slug": "single",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "maybe-single",
|
|
"title": "Retrieve zero or one row of data",
|
|
"slug": "maybesingle",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "csv",
|
|
"title": "Retrieve as a CSV",
|
|
"slug": "db-csv",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "returns",
|
|
"title": "Override type of successful response",
|
|
"slug": "db-returns",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "overrideTypes",
|
|
"title": "Partially override or replace type of successful response",
|
|
"slug": "db-overrideTypes",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "explain",
|
|
"title": "Using explain",
|
|
"slug": "explain",
|
|
"product": "database",
|
|
"parent": "modifiers",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create a query builder instance",
|
|
"slug": "constructor",
|
|
"product": "database",
|
|
"type": "function",
|
|
"parent": "modifiers"
|
|
},
|
|
{
|
|
"id": "maxaffected",
|
|
"title": "Set the maximum number of rows that can be affected by the query",
|
|
"slug": "maxaffected",
|
|
"product": "database",
|
|
"type": "function",
|
|
"parent": "modifiers"
|
|
},
|
|
{
|
|
"id": "rollback",
|
|
"title": "Rollback the query",
|
|
"slug": "rollback",
|
|
"product": "database",
|
|
"type": "function",
|
|
"parent": "modifiers"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create a query builder instance",
|
|
"slug": "constructor",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "setheader",
|
|
"title": "Set an HTTP header for the request",
|
|
"slug": "setheader",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "then",
|
|
"title": "Attaches callbacks for the resolution and/or rejection of the Promise",
|
|
"slug": "then",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "throwonerror",
|
|
"title": "If there's an error with the query, throwOnError will reject the promise by",
|
|
"slug": "throwonerror",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Creates a PostgREST client",
|
|
"slug": "constructor",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from",
|
|
"title": "Perform a query on a table or a view",
|
|
"slug": "from",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "schema",
|
|
"title": "Select a schema to query or perform an function (rpc) call",
|
|
"slug": "schema",
|
|
"product": "database",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create a query builder instance",
|
|
"slug": "constructor",
|
|
"product": "database",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Auth",
|
|
"items": [
|
|
{
|
|
"id": "auth-api",
|
|
"title": "Overview",
|
|
"slug": "auth-api",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-up",
|
|
"title": "Create a new user",
|
|
"slug": "auth-signup",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "on-auth-state-change",
|
|
"title": "Listen to auth events",
|
|
"slug": "auth-onauthstatechange",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-anonymously",
|
|
"title": "Create an anonymous user",
|
|
"slug": "auth-signinanonymously",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-password",
|
|
"title": "Sign in a user",
|
|
"slug": "auth-signinwithpassword",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-id-token",
|
|
"title": "Sign in with ID token (native sign-in)",
|
|
"slug": "auth-signinwithidtoken",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-otp",
|
|
"title": "Sign in a user through OTP",
|
|
"slug": "auth-signinwithotp",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-oauth",
|
|
"title": "Sign in a user through OAuth",
|
|
"slug": "auth-signinwithoauth",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-sso",
|
|
"title": "Sign in a user through SSO",
|
|
"slug": "auth-signinwithsso",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-in-with-web3",
|
|
"title": "Sign in a user through Web3 (Solana, Ethereum)",
|
|
"slug": "auth-signinwithweb3",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-claims",
|
|
"title": "Get user claims from verified JWT",
|
|
"slug": "auth-getclaims",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sign-out",
|
|
"title": "Sign out a user",
|
|
"slug": "auth-signout",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "reset-password-for-email",
|
|
"title": "Send a password reset request",
|
|
"slug": "auth-resetpasswordforemail",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "verify-otp",
|
|
"title": "Verify and log in through OTP",
|
|
"slug": "auth-verifyotp",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-session",
|
|
"title": "Retrieve a session",
|
|
"slug": "auth-getsession",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "refresh-session",
|
|
"title": "Retrieve a new session",
|
|
"slug": "auth-refreshsession",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-user",
|
|
"title": "Retrieve a user",
|
|
"slug": "auth-getuser",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "update-user",
|
|
"title": "Update a user",
|
|
"slug": "auth-updateuser",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-user-identities",
|
|
"title": "Retrieve identities linked to a user",
|
|
"slug": "auth-getuseridentities",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "link-identity",
|
|
"title": "Link an identity to a user",
|
|
"slug": "auth-linkidentity",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "unlink-identity",
|
|
"title": "Unlink an identity from a user",
|
|
"slug": "auth-unlinkidentity",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "send-password-reauthentication",
|
|
"title": "Send a password reauthentication nonce",
|
|
"slug": "auth-reauthentication",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "resend-email-or-phone-otps",
|
|
"title": "Resend an OTP",
|
|
"slug": "auth-resend",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "set-session",
|
|
"title": "Set the session data",
|
|
"slug": "auth-setsession",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "exchange-code-for-session",
|
|
"title": "Exchange an auth code for a session",
|
|
"slug": "auth-exchangecodeforsession",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "start-auto-refresh",
|
|
"title": "Start auto-refresh session (non-browser)",
|
|
"slug": "auth-startautorefresh",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "stop-auto-refresh",
|
|
"title": "Stop auto-refresh session (non-browser)",
|
|
"slug": "auth-stopautorefresh",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "auth-mfa-api",
|
|
"title": "Auth MFA",
|
|
"slug": "auth-mfa-api",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "mfa-enroll",
|
|
"title": "Enroll a factor",
|
|
"slug": "auth-mfa-enroll",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-challenge",
|
|
"title": "Create a challenge",
|
|
"slug": "auth-mfa-challenge",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-verify",
|
|
"title": "Verify a challenge",
|
|
"slug": "auth-mfa-verify",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-challenge-and-verify",
|
|
"title": "Create and verify a challenge",
|
|
"slug": "auth-mfa-challengeandverify",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-unenroll",
|
|
"title": "Unenroll a factor",
|
|
"slug": "auth-mfa-unenroll",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-get-authenticator-assurance-level",
|
|
"title": "Get Authenticator Assurance Level",
|
|
"slug": "auth-mfa-getauthenticatorassurancelevel",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "listfactors",
|
|
"title": "List MFA factors for user",
|
|
"slug": "auth-mfa-listfactors",
|
|
"product": "auth",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "admin-api",
|
|
"title": "Auth Admin",
|
|
"slug": "admin-api",
|
|
"type": "function",
|
|
"items": [
|
|
{
|
|
"id": "get-user-by-id",
|
|
"title": "Retrieve a user",
|
|
"slug": "auth-admin-getuserbyid",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "list-users",
|
|
"title": "List all users",
|
|
"slug": "auth-admin-listusers",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "create-user",
|
|
"title": "Create a user",
|
|
"slug": "auth-admin-createuser",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "delete-user",
|
|
"title": "Delete a user",
|
|
"slug": "auth-admin-deleteuser",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "invite-user-by-email",
|
|
"title": "Send an email invite link",
|
|
"slug": "auth-admin-inviteuserbyemail",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "generate-link",
|
|
"title": "Generate an email link",
|
|
"slug": "auth-admin-generatelink",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "update-user-by-id",
|
|
"title": "Update a user",
|
|
"slug": "auth-admin-updateuserbyid",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-list-factors-admin",
|
|
"title": "List MFA factors",
|
|
"slug": "auth-admin-mfa-listfactors",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "mfa-delete-factor",
|
|
"title": "Delete a factor for a user",
|
|
"slug": "auth-admin-mfa-deletefactor",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create an Auth Admin API instance",
|
|
"slug": "auth-constructor",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "createuser",
|
|
"title": "Creates a new user",
|
|
"slug": "auth-createuser",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "deleteuser",
|
|
"title": "Delete a user. Requires a key",
|
|
"slug": "auth-deleteuser",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "generatelink",
|
|
"title": "Generates email links and OTPs to be sent via a custom email provider",
|
|
"slug": "auth-generatelink",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "getuserbyid",
|
|
"title": "Get user by id",
|
|
"slug": "auth-getuserbyid",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "inviteuserbyemail",
|
|
"title": "Sends an invite link to an email address",
|
|
"slug": "auth-inviteuserbyemail",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "listusers",
|
|
"title": "Get a list of users",
|
|
"slug": "auth-listusers",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "signout",
|
|
"title": "Removes a logged-in session",
|
|
"slug": "auth-signout",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "updateuserbyid",
|
|
"title": "Updates the user data",
|
|
"slug": "auth-updateuserbyid",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create an Auth Admin API instance",
|
|
"slug": "auth-constructor",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "signout",
|
|
"title": "Removes a logged-in session",
|
|
"slug": "auth-signout",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "createclient",
|
|
"title": "Creates a new OAuth client",
|
|
"slug": "auth-createclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "deleteclient",
|
|
"title": "Deletes an OAuth client",
|
|
"slug": "auth-deleteclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "getclient",
|
|
"title": "Gets details of a specific OAuth client",
|
|
"slug": "auth-getclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "listclients",
|
|
"title": "Lists all OAuth clients with optional pagination",
|
|
"slug": "auth-listclients",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "regenerateclientsecret",
|
|
"title": "Regenerates the secret for an OAuth client",
|
|
"slug": "auth-regenerateclientsecret",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "updateclient",
|
|
"title": "Updates an existing OAuth client",
|
|
"slug": "auth-updateclient",
|
|
"product": "auth-admin",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create a new client for use in the browser",
|
|
"slug": "auth-constructor",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "initialize",
|
|
"title": "Initializes the client session either from the url or from storage",
|
|
"slug": "auth-initialize",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "isthrowonerrorenabled",
|
|
"title": "Returns whether error throwing mode is enabled for this client",
|
|
"slug": "auth-isthrowonerrorenabled",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "approveauthorization",
|
|
"title": "Approves an OAuth authorization request",
|
|
"slug": "auth-approveauthorization",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "denyauthorization",
|
|
"title": "Denies an OAuth authorization request",
|
|
"slug": "auth-denyauthorization",
|
|
"product": "auth",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "getauthorizationdetails",
|
|
"title": "Retrieves details about an OAuth authorization request",
|
|
"slug": "auth-getauthorizationdetails",
|
|
"product": "auth",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Edge Functions",
|
|
"items": [
|
|
{
|
|
"id": "invoke",
|
|
"title": "Invokes a Supabase Edge Function.",
|
|
"slug": "functions-invoke",
|
|
"product": "functions",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create a Functions client instance",
|
|
"slug": "functions-constructor",
|
|
"product": "functions",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "setauth",
|
|
"title": "Updates the authorization header",
|
|
"slug": "functions-setauth",
|
|
"product": "functions",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Realtime",
|
|
"items": [
|
|
{
|
|
"id": "subscribe",
|
|
"title": "Subscribe to channel",
|
|
"slug": "subscribe",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "remove-channel",
|
|
"title": "Unsubscribe from a channel",
|
|
"slug": "removechannel",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "remove-all-channels",
|
|
"title": "Unsubscribe from all channels",
|
|
"slug": "removeallchannels",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-channels",
|
|
"title": "Retrieve all channels",
|
|
"slug": "getchannels",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "broadcast-message",
|
|
"title": "Broadcast a message",
|
|
"slug": "broadcastmessage",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create a Realtime client instance",
|
|
"slug": "constructor",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "httpsend",
|
|
"title": "Sends a broadcast message explicitly via REST API",
|
|
"slug": "httpsend",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "presencestate",
|
|
"title": "Access current presence state",
|
|
"slug": "presencestate",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "teardown",
|
|
"title": "Teardown the channel",
|
|
"slug": "teardown",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "track",
|
|
"title": "Track user presence in channel",
|
|
"slug": "track",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "unsubscribe",
|
|
"title": "Leaves the channel",
|
|
"slug": "unsubscribe",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "untrack",
|
|
"title": "Stop tracking user presence",
|
|
"slug": "untrack",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "updatejoinpayload",
|
|
"title": "Update channel join payload",
|
|
"slug": "updatejoinpayload",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Initializes the Socket",
|
|
"slug": "constructor",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "channel",
|
|
"title": "Create or retrieve a channel",
|
|
"slug": "channel",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "connect",
|
|
"title": "Connects the socket, unless already connected",
|
|
"slug": "connect",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "connectionstate",
|
|
"title": "Returns the current state of the socket",
|
|
"slug": "connectionstate",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "disconnect",
|
|
"title": "Disconnects the socket",
|
|
"slug": "disconnect",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "endpointurl",
|
|
"title": "Returns the URL of the websocket",
|
|
"slug": "endpointurl",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "flushsendbuffer",
|
|
"title": "Flushes send buffer",
|
|
"slug": "flushsendbuffer",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "getchannels",
|
|
"title": "Returns all created channels",
|
|
"slug": "getchannels",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "isconnected",
|
|
"title": "Returns is the connection is open",
|
|
"slug": "isconnected",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "isconnecting",
|
|
"title": "Returns if the connection is currently connecting",
|
|
"slug": "isconnecting",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "isdisconnecting",
|
|
"title": "Returns if the connection is currently disconnecting",
|
|
"slug": "isdisconnecting",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "log",
|
|
"title": "Logs the message",
|
|
"slug": "log",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "onheartbeat",
|
|
"title": "Handle heartbeat events",
|
|
"slug": "onheartbeat",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "push",
|
|
"title": "Push out a message if the socket is connected",
|
|
"slug": "push",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "removeallchannels",
|
|
"title": "Unsubscribes and removes all channels",
|
|
"slug": "removeallchannels",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "removechannel",
|
|
"title": "Unsubscribes and removes a single channel",
|
|
"slug": "removechannel",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sendheartbeat",
|
|
"title": "Sends a heartbeat message if the socket is connected",
|
|
"slug": "sendheartbeat",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "setauth",
|
|
"title": "Sets the JWT access token used for channel subscription authorization and Realtime RLS",
|
|
"slug": "setauth",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Initializes the Presence",
|
|
"slug": "constructor",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create a Realtime client instance",
|
|
"slug": "constructor",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "createwebsocket",
|
|
"title": "Create WebSocket connection",
|
|
"slug": "createwebsocket",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "getwebsocketconstructor",
|
|
"title": "Get WebSocket constructor function",
|
|
"slug": "getwebsocketconstructor",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "iswebsocketsupported",
|
|
"title": "Check if WebSocket is supported",
|
|
"slug": "iswebsocketsupported",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "addeventlistener",
|
|
"title": "Add WebSocket event listener",
|
|
"slug": "addeventlistener",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "close",
|
|
"title": "Close WebSocket connection",
|
|
"slug": "close",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "removeeventlistener",
|
|
"title": "Remove WebSocket event listener",
|
|
"slug": "removeeventlistener",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "send",
|
|
"title": "Send message through WebSocket",
|
|
"slug": "send",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create a Realtime client instance",
|
|
"slug": "constructor",
|
|
"product": "realtime",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Storage",
|
|
"items": [
|
|
{
|
|
"id": "create-bucket",
|
|
"title": "Create a bucket",
|
|
"slug": "storage-createbucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "get-bucket",
|
|
"title": "Retrieve a bucket",
|
|
"slug": "storage-getbucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "list-buckets",
|
|
"title": "List all buckets",
|
|
"slug": "storage-listbuckets",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "update-bucket",
|
|
"title": "Update a bucket",
|
|
"slug": "storage-updatebucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "delete-bucket",
|
|
"title": "Delete a bucket",
|
|
"slug": "storage-deletebucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "empty-bucket",
|
|
"title": "Empty a bucket",
|
|
"slug": "storage-emptybucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-upload",
|
|
"title": "Upload a file",
|
|
"slug": "storage-from-upload",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-download",
|
|
"title": "Download a file",
|
|
"slug": "storage-from-download",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-list",
|
|
"title": "List all files in a bucket",
|
|
"slug": "storage-from-list",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-update",
|
|
"title": "Replace an existing file",
|
|
"slug": "storage-from-update",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-move",
|
|
"title": "Move an existing file",
|
|
"slug": "storage-from-move",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-copy",
|
|
"title": "Copy an existing file",
|
|
"slug": "storage-from-copy",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-remove",
|
|
"title": "Delete files in a bucket",
|
|
"slug": "storage-from-remove",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-create-signed-url",
|
|
"title": "Create a signed URL",
|
|
"slug": "storage-from-createsignedurl",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-create-signed-urls",
|
|
"title": "Create signed URLs",
|
|
"slug": "storage-from-createsignedurls",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-create-signed-upload-url",
|
|
"title": "Create signed upload URL",
|
|
"slug": "storage-from-createsigneduploadurl",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-upload-to-signed-url",
|
|
"title": "Upload to a signed URL",
|
|
"slug": "storage-from-uploadtosignedurl",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from-get-public-url",
|
|
"title": "Retrieve public URL",
|
|
"slug": "storage-from-getpublicurl",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "putvectors",
|
|
"title": "Insert or update vectors",
|
|
"slug": "storage-putvectors",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "queryvectors",
|
|
"title": "Query for similar vectors",
|
|
"slug": "storage-queryvectors",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "getvectors",
|
|
"title": "Retrieve vectors by keys",
|
|
"slug": "storage-getvectors",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "listvectors",
|
|
"title": "List vectors in an index",
|
|
"slug": "storage-listvectors",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "deletevectors",
|
|
"title": "Delete vectors by keys",
|
|
"slug": "storage-deletevectors",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create a Storage client instance",
|
|
"slug": "storage-constructor",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from",
|
|
"title": "Access operations for a specific vector bucket",
|
|
"slug": "storage-from",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Creates a new VectorBucketApi instance",
|
|
"slug": "storage-constructor",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "createbucket",
|
|
"title": "Creates a new vector bucket",
|
|
"slug": "storage-createbucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "deletebucket",
|
|
"title": "Deletes a vector bucket",
|
|
"slug": "storage-deletebucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "getbucket",
|
|
"title": "Retrieves metadata for a specific vector bucket",
|
|
"slug": "storage-getbucket",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "listbuckets",
|
|
"title": "Lists vector buckets with optional filtering and pagination",
|
|
"slug": "storage-listbuckets",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "throwonerror",
|
|
"title": "Enable throwing errors instead of returning them in the response",
|
|
"slug": "storage-throwonerror",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "createindex",
|
|
"title": "Creates a new vector index in this bucket",
|
|
"slug": "storage-createindex",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "deleteindex",
|
|
"title": "Deletes an index from this bucket",
|
|
"slug": "storage-deleteindex",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "getindex",
|
|
"title": "Retrieves metadata for a specific index in this bucket",
|
|
"slug": "storage-getindex",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "index",
|
|
"title": "Access operations for a specific index within this bucket",
|
|
"slug": "storage-index",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "listindexes",
|
|
"title": "Lists indexes in this bucket",
|
|
"slug": "storage-listindexes",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "throwonerror",
|
|
"title": "Enable throwing errors instead of returning them in the response",
|
|
"slug": "storage-throwonerror",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "createindex",
|
|
"title": "Creates a new vector index within a bucket",
|
|
"slug": "storage-createindex",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "deleteindex",
|
|
"title": "Deletes a vector index and all its data",
|
|
"slug": "storage-deleteindex",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "getindex",
|
|
"title": "Retrieves metadata for a specific vector index",
|
|
"slug": "storage-getindex",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "listindexes",
|
|
"title": "Lists vector indexes within a bucket with optional filtering and pagination",
|
|
"slug": "storage-listindexes",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "throwonerror",
|
|
"title": "Enable throwing errors instead of returning them in the response",
|
|
"slug": "storage-throwonerror",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from",
|
|
"title": "Perform file operation in a bucket",
|
|
"slug": "storage-from",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "throwonerror",
|
|
"title": "Enable throwing errors instead of returning them",
|
|
"slug": "storage-throwonerror",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "exists",
|
|
"title": "Checks the existence of a file",
|
|
"slug": "storage-exists",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "info",
|
|
"title": "Retrieves the details of an existing file",
|
|
"slug": "storage-info",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "listv2",
|
|
"title": "this method signature might change in the future",
|
|
"slug": "storage-listv2",
|
|
"product": "storage",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "throwonerror",
|
|
"title": "Enable throwing errors instead of returning them",
|
|
"slug": "storage-throwonerror",
|
|
"product": "storage",
|
|
"type": "function"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "category",
|
|
"title": "Misc",
|
|
"excludes": [
|
|
"reference_dart_v1",
|
|
"reference_dart_v2",
|
|
"reference_javascript_v1",
|
|
"reference_javascript_v2",
|
|
"reference_kotlin_v1",
|
|
"reference_kotlin_v2",
|
|
"reference_python_v2",
|
|
"reference_swift_v1",
|
|
"reference_swift_v2",
|
|
"reference_kotlin_v3"
|
|
],
|
|
"items": [
|
|
{
|
|
"title": "Release Notes",
|
|
"id": "release-notes",
|
|
"slug": "release-notes",
|
|
"isFunc": false,
|
|
"type": "markdown"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Create a client instance",
|
|
"slug": "constructor",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "httpsend",
|
|
"title": "Sends a broadcast message explicitly via REST API",
|
|
"slug": "httpsend",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "on",
|
|
"title": "Creates an event handler that listens to changes",
|
|
"slug": "on",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "presencestate",
|
|
"title": "Access current presence state",
|
|
"slug": "presencestate",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "send",
|
|
"title": "Sends a message into the channel",
|
|
"slug": "send",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "teardown",
|
|
"title": "Teardown the channel",
|
|
"slug": "teardown",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "track",
|
|
"title": "Track user presence in channel",
|
|
"slug": "track",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "unsubscribe",
|
|
"title": "Leaves the channel",
|
|
"slug": "unsubscribe",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "untrack",
|
|
"title": "Stop tracking user presence",
|
|
"slug": "untrack",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "updatejoinpayload",
|
|
"title": "Update channel join payload",
|
|
"slug": "updatejoinpayload",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "constructor",
|
|
"title": "Initializes the Socket",
|
|
"slug": "constructor",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "channel",
|
|
"title": "Create or retrieve a channel",
|
|
"slug": "channel",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "connect",
|
|
"title": "Connects the socket, unless already connected",
|
|
"slug": "connect",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "connectionstate",
|
|
"title": "Returns the current state of the socket",
|
|
"slug": "connectionstate",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "disconnect",
|
|
"title": "Disconnects the socket",
|
|
"slug": "disconnect",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "endpointurl",
|
|
"title": "Returns the URL of the websocket",
|
|
"slug": "endpointurl",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "flushsendbuffer",
|
|
"title": "Flushes send buffer",
|
|
"slug": "flushsendbuffer",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "getchannels",
|
|
"title": "Returns all created channels",
|
|
"slug": "getchannels",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "isconnected",
|
|
"title": "Returns is the connection is open",
|
|
"slug": "isconnected",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "isconnecting",
|
|
"title": "Returns if the connection is currently connecting",
|
|
"slug": "isconnecting",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "isdisconnecting",
|
|
"title": "Returns if the connection is currently disconnecting",
|
|
"slug": "isdisconnecting",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "log",
|
|
"title": "Logs the message",
|
|
"slug": "log",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "onheartbeat",
|
|
"title": "Handle heartbeat events",
|
|
"slug": "onheartbeat",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "push",
|
|
"title": "Push out a message if the socket is connected",
|
|
"slug": "push",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "removeallchannels",
|
|
"title": "Unsubscribes and removes all channels",
|
|
"slug": "removeallchannels",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "removechannel",
|
|
"title": "Unsubscribes and removes a single channel",
|
|
"slug": "removechannel",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "sendheartbeat",
|
|
"title": "Sends a heartbeat message if the socket is connected",
|
|
"slug": "sendheartbeat",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "setauth",
|
|
"title": "Sets the JWT access token used for channel subscription authorization and Realtime RLS",
|
|
"slug": "setauth",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "channel",
|
|
"title": "Creates a Realtime channel with Broadcast, Presence, and Postgres Changes",
|
|
"slug": "channel",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "from",
|
|
"title": "Perform a query on a table or a view",
|
|
"slug": "from",
|
|
"product": "misc",
|
|
"type": "function"
|
|
},
|
|
{
|
|
"id": "schema",
|
|
"title": "Select a schema to query or perform an function (rpc) call",
|
|
"slug": "schema",
|
|
"product": "misc",
|
|
"type": "function"
|
|
}
|
|
]
|
|
}
|
|
]
|