The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
docs: Update documentation from Dart, and Swift SDK changes (#47583)
Guilherme Souza47912201e04e
diff --git a/apps/docs/spec/supabase_dart_v2.yml b/apps/docs/spec/supabase_dart_v2.ymlindex b1592131130..66393e48d8f 100644--- a/apps/docs/spec/supabase_dart_v2.yml+++ b/apps/docs/spec/supabase_dart_v2.yml@@ -2589,11 +2589,16 @@ functions:notes: |Delete a user.- The `deleteUser()` method requires the user's ID, which maps to the `auth.users.id` column.+ - When `shouldSoftDelete` is `true`, the user is soft-deleted: their record and associated data are retained but the user is marked as deleted. Defaults to `false`, which permanently removes the user.params:- name: idisOptional: falsetype: Stringdescription: ID of the user to be deleted.+ - name: shouldSoftDelete+ isOptional: true+ type: bool+ description: If true, soft-deletes the user (keeps the record but marks it deleted). Defaults to false (permanent delete).examples:- id: removes-a-username: Removes a user@@ -2603,6 +2608,16 @@ functions:await supabase.auth.admin.deleteUser('715ed5db-f090-4b8c-a067-640ecee36aa0');```+ - id: soft-delete-a-user+ name: Soft-delete a user+ code: |+ ```dart+ await supabase.auth.admin+ .deleteUser(+ '715ed5db-f090-4b8c-a067-640ecee36aa0',+ shouldSoftDelete: true,+ );+ ```- id: invite-user-by-emailtitle: 'inviteUserByEmail()'notes: |@@ -4634,6 +4649,10 @@ functions:isOptional: falsetype: intdescription: The number of seconds until the signed URL expires. For example, 60 for a URL which is valid for one minute.+ - name: download+ isOptional: true+ type: DownloadBehavior+ description: Triggers the file to be downloaded rather than opened in the browser. Use `DownloadBehavior.withOriginalName` to keep the original file name or `DownloadBehavior.named('custom.png')` to override it.- name: transformisOptional: truetype: TransformOptions@@ -4690,6 +4709,61 @@ functions:```json'https://example.supabase.co/storage/v1/object/sign/avatars/folder/avatar1.png?token=<TOKEN>''```+ - id: create-signed-url-with-download+ name: With download+ code: |+ ```dart+ final String signedUrl = await supabase+ .storage+ .from('avatars')+ .createSignedUrl(+ 'avatar1.png',+ 60,+ download: DownloadBehavior.withOriginalName,+ );+ ```++ - id: from-create-signed-upload-url+ description: |+ Creates a signed upload URL. Signed upload URLs can be used to upload files to a bucket without further authentication. They are valid for 2 hours.+ title: 'from.createSignedUploadUrl()'+ notes: |+ - Policy permissions required:+ - `buckets` permissions: none+ - `objects` permissions: `insert`+ - Refer to the [Storage guide](https://supabase.com/docs/guides/storage/security/access-control) on how access control works+ params:+ - name: path+ isOptional: false+ type: String+ description: The file path, including the current file name. For example folder/image.png.+ - name: upsert+ isOptional: true+ type: bool+ description: If true, the signed URL allows overwriting an existing file at the path. Defaults to false.+ examples:+ - id: create-signed-upload-url+ name: Create signed upload URL+ isSpotlight: true+ code: |+ ```dart+ final response = await supabase+ .storage+ .from('avatars')+ .createSignedUploadUrl('folder/avatar1.png');+ ```+ - id: create-signed-upload-url-with-upsert+ name: With upsert+ code: |+ ```dart+ final response = await supabase+ .storage+ .from('avatars')+ .createSignedUploadUrl(+ 'folder/avatar1.png',+ upsert: true,+ );+ ```- id: from-get-public-urldescription: |@@ -4706,6 +4780,10 @@ functions:isOptional: falsetype: Stringdescription: The path and name of the file to generate the public URL for. For example folder/image.png.+ - name: download+ isOptional: true+ type: DownloadBehavior+ description: Triggers the file to be downloaded rather than opened in the browser. Use `DownloadBehavior.withOriginalName` to keep the original file name or `DownloadBehavior.named('custom.png')` to override it.- name: transformisOptional: truetype: TransformOptions@@ -4766,6 +4844,18 @@ functions:```json'https://example.supabase.co/storage/v1/object/public/public-bucket/folder/avatar1.png'```+ - id: returns-the-url-for-an-asset-with-download+ name: Trigger download+ code: |+ ```dart+ final String publicUrl = supabase+ .storage+ .from('public-bucket')+ .getPublicUrl(+ 'avatar1.png',+ download: DownloadBehavior.withOriginalName,+ );+ ```- id: from-downloaddescription: |diff --git a/apps/docs/spec/supabase_swift_v2.yml b/apps/docs/spec/supabase_swift_v2.ymlindex 4fcb84eb1d3..043346624fa 100644--- a/apps/docs/spec/supabase_swift_v2.yml+++ b/apps/docs/spec/supabase_swift_v2.yml@@ -4384,6 +4384,8 @@ functions:It's best to only enable this for testing environments but if you wish to enable it for production you can provide additional protection by using a `pre-request` function.Follow the [Performance Debugging Guide](/docs/guides/database/debugging-performance) to enable the functionality on your project.+ notes: |+ The `format` parameter accepts an `ExplainFormat` value — either `.text` (default, human-readable) or `.json` (machine-readable JSON).examples:- id: get-execution-planname: Get the execution plan@@ -4463,6 +4465,21 @@ functions:By default, the data is returned in TEXT format, but can also be returned as JSON by using the `format` parameter.hideCodeBlock: trueisSpotlight: false++ - id: get-execution-plan-json-format+ name: Get the execution plan as JSON+ code: |+ ```swift+ try await supabase+ .from("instruments")+ .select()+ .explain(format: .json)+ .execute()+ .value+ ```+ description: |+ Use `format: .json` to get a machine-readable JSON execution plan. The `ExplainFormat` type accepts `.text` (default) or `.json`.+ isSpotlight: false- id: invoketitle: invoke()description: |@@ -5176,7 +5193,7 @@ functions:.createBucket("avatars",options: BucketOptions(- public: false,+ isPublic: false,allowedMimeTypes: ["image/png"],fileSizeLimit: 1024)@@ -5216,7 +5233,7 @@ functions:.updateBucket("avatars",options: BucketOptions(- public: false,+ isPublic: false,fileSizeLimit: 1024,allowedMimeTypes: ["image/png"])@@ -5375,12 +5392,13 @@ functions:let signedURL = try await supabase.storage.from("avatars").createSignedURL(- path: "folder/avatar1.png", expiresIn: 60,- download: true+ path: "folder/avatar1.png",+ expiresIn: 60,+ download: .withOriginalName)```note: |- You can also sepcify a `String` in the `download` parameter to define the file name for the downloaded asset.+ Use `.withOriginalName` to download with the original file name, or `.named("custom.png")` to specify a custom file name. The `download: Bool` overload still compiles but is disfavored.- id: from-create-signed-urlstitle: from.createSignedUrls()@@ -5519,11 +5537,11 @@ functions:.from("public-bucket").getPublicURL(path: "folder/avatar1.png",- download: true+ download: .withOriginalName)```note: |- You can also sepcify a `String` in the `download` parameter to define the file name for the downloaded asset.+ Use `.withOriginalName` to download with the original file name, or `.named("custom.png")` to specify a custom file name. The `download: Bool` overload still compiles but is disfavored.- id: from-downloadtitle: from.download()