AnalyticDB:Use Edge Functions in AnalyticDB Supabase

Deploy using the Dashboard

1. Log on to the Supabase Dashboard.

2. In the sidebar of the Dashboard, click Edge Function > Functions.

3. In the upper-right corner of the page, click Deploy a new function and select Via Editor from the drop-down list.

   

4. Write your code in the code editor.

   Important

   To import third-party dependencies or call public network APIs in a function, you must enable public network access for the AnalyticDB for PostgreSQL Supabase project.

   The following example includes index.ts, which is the entry file, and foo.ts.

   • The index.ts file is as follows:

     import { foo } from './foo.ts';
     console.info('server started');
     Deno.serve(async (req)=>{
       const { name } = await req.json();
       const data = {
         message: `Hello ${foo()} ${name}!`
       };
       return new Response(JSON.stringify(data), {
         headers: {
           'Content-Type': 'application/json',
           'Connection': 'keep-alive'
         }
       });
     });

   • The foo.ts file is as follows:

     export function foo() {
       return 'bar';
     }

5. In the lower-right corner, enter a name for the Edge Function, and then click Deploy.

Deploy using the functions-cli tool

1. Obtain and configure the SUPABASE_API_URL and SUPABASE_API_KEY for the target project.

   The SUPABASE_API_KEY is the service role key. For more information about how to obtain the configuration information, see Get API Keys. You can configure the key in the following ways:

   • Environment variable: export SUPABASE_API_KEY=xxx

   • .env file: SUPABASE_API_KEY=xxx

   • Command line parameter: -key xxx

   The following example shows how to configure the key using an environment variable:

   export SUPABASE_API_URL=https://sbp-xxx.supabase.opentrust.net
   export SUPABASE_API_KEY=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyb2xlIjoic2Vxxxx

2. Prepare the function files.

   This example uses the following function folder structure, which includes index.ts as the entry file and foo.ts.

   supabase
   └── functions
   └── hello
   ├── foo.ts
   └── index.ts

   • The index.ts file is as follows:

     import { foo } from './foo.ts';
     console.info('server started');
     Deno.serve(async (req)=>{
       const { name } = await req.json();
       const data = {
         message: `Hello ${foo()} ${name}!`
       };
       return new Response(JSON.stringify(data), {
         headers: {
           'Content-Type': 'application/json',
           'Connection': 'keep-alive'
         }
       });
     });

   • The foo.ts file is as follows:

     export function foo() {
       return 'bar';
     }

3. Download the functions-cli tool. When you run the following commands, replace functions-cli with the name of the downloaded CLI tool.

   • functions-cli-darwin-arm64

   • functions-cli-darwin-amd64

   • functions-cli-windows-386.exe

   • functions-cli-windows-amd64.exe

   • functions-cli-linux-386

   • functions-cli-linux-amd64

   • functions-cli-linux-arm

   • functions-cli-linux-arm64

4. Run the deployment command.

   ./functions-cli deploy hello

   Note

   • The deployment command searches for the supabase/functions/ path and a function directory named hello in the directory from which the command is run.

   • If the error "At least one file is required" occurs, log on to AnalyticDB for PostgreSQL Supabase console. In the Actions column of the target Supabase project, choose More > Upgraded Version and then retry the operation. If your project version is v1.0.0, the database connection string will be updated after the upgrade.

Test using the Dashboard

1. In the upper-right corner of the Functions page, click the Test button.

   

2. In the panel, click Send Request in the lower-right corner.

   

Test using a curl command

On the Details tab, copy the curl command and replace [YOUR ANON KEY] with the anon key or service role key.

The following is an example response:

Migrate from Supabase Cloud to AnalyticDB Supabase

Sync between AnalyticDB Supabase projects

Create on Dashboard

1. In the sidebar of the Dashboard, click Edge Function > Secrets.

2. Enter the key and value.

   

3. Click Save to add the secret.

Creating with the functions-cli tool

1. Download the functions-cli tool. When you run the following commands, replace functions-cli with the name of the downloaded CLI tool.

   • functions-cli-darwin-arm64

   • functions-cli-darwin-amd64

   • functions-cli-windows-386.exe

   • functions-cli-windows-amd64.exe

   • functions-cli-linux-386

   • functions-cli-linux-amd64

   • functions-cli-linux-arm

   • functions-cli-linux-arm64

2. Run the command.

   # Add one secret
   functions-cli secrets set DASHSCOPE_API_KEY=sk_test123456
   
   # Add multiple secrets
   functions-cli secrets set DASHSCOPE_API_KEY=sk_test123456 OPENAI_API_KEY=test123456 
   
   # Add secrets from an .env file
   functions-cli secrets set --env-file supabase/functions/.env