Supabase CLI

初始化Supabase本地开发的配置。

将在当前工作目录下创建supabase/config.toml文件。该配置针对每个本地项目是特定的。

您可以通过指定SUPABASE_WORKDIR环境变量或--workdir标志来覆盖目录路径。

除了config.toml外，supabase目录还可能包含其他Supabase对象，如migrations（迁移）、functions（函数）、tests（测试）等。

通过使用您的个人访问令牌登录，将Supabase CLI连接到您的Supabase账户。

您的访问令牌安全地存储在本地凭证存储中。如果本地凭证存储不可用，它将被写入到~/.supabase/access-token的纯文本文件中。

如果不希望出现此行为，例如在CI环境中，您可以通过在其他命令中指定SUPABASE_ACCESS_TOKEN环境变量来跳过登录。

Supabase CLI使用存储的令牌访问用于项目、函数、密钥等的管理API。

将您的本地开发项目与托管的Supabase项目关联。

PostgREST配置将从Supabase平台获取，并与您的本地配置文件进行验证。

如果提供密码，可选择验证数据库设置。您的数据库密码将保存在本地凭据存储中（如可用）。

若您不希望被提示输入数据库密码（例如在CI环境中），可以通过SUPABASE_DB_PASSWORD环境变量显式指定。

诸如db dump、db push和db pull等命令需要先关联项目。

启动Supabase本地开发环境。

需要先在当前工作目录通过运行supabase init命令生成supabase/config.toml配置文件。

默认会启动所有服务容器。可通过-x参数排除不需要的容器。如需排除多个容器，可以传入逗号分隔的字符串（如-x gotrue,imgproxy），或多次指定-x参数。

建议至少配备7GB内存以启动所有服务。

系统会自动添加健康检查来验证已启动的容器。使用--ignore-health-check参数可忽略这些错误。

停止Supabase本地开发堆栈。

需在当前工作目录中通过运行supabase init命令创建supabase/config.toml文件。

所有Docker资源在重启时都会保留。使用--no-backup标志可在重启间重置本地开发数据。

使用--all标志可停止机器上所有本地Supabase项目实例。与--no-backup同时使用需谨慎，这将删除所有supabase本地项目数据。

显示Supabase本地开发堆栈的状态。

需要先通过运行supabase start或supabase db start命令启动本地开发堆栈。

通过指定-o env标志，可以导出用于初始化supabase-js的连接参数。支持的参数包括JWT_SECRET、ANON_KEY和SERVICE_ROLE_KEY。

对本地数据库执行pgTAP测试。

要求通过运行supabase start启动本地开发堆栈。

在容器中运行pg_prove，并将单元测试文件从supabase/tests目录挂载到容器中。测试文件后缀可以是.sql或.pg。

由于每个测试都在自己的事务中运行，无论成功或失败，都会单独回滚。

基于您的 Postgres 数据库模式自动生成类型定义。

该命令会连接到您的数据库（本地或远程），并生成与数据库表、视图和存储过程匹配的类型化定义。默认生成 TypeScript 定义，但也支持 Go 和 Swift。

生成的类型使您在代码中操作数据库时获得类型安全性和自动补全功能，有助于防止运行时错误并提升开发体验。

这些类型会遵循数据库模式中定义的关系、约束和自定义类型。

从远程数据库拉取架构变更。将在supabase/migrations目录下创建新的迁移文件。

要求通过运行supabase link将本地项目链接到远程数据库。对于自托管数据库，可以使用--db-url参数传入连接配置。

可选择在迁移历史表中插入新行以反映远程数据库当前状态。

若迁移历史表中无条目，将使用pg_dump捕获您创建的所有远程架构内容。否则该命令仅会比对远程数据库的架构差异，类似于运行db diff --linked。

将所有本地迁移推送至远程数据库。

需先通过运行supabase link命令将本地项目与远程数据库关联。对于自托管数据库，可使用--db-url参数传入连接配置。

首次运行此命令时，将在supabase_migrations.schema_migrations下创建迁移历史表。成功应用迁移后，会以时间戳作为唯一ID向迁移历史表插入新记录。后续推送将自动跳过已应用的迁移。

如需修改迁移历史表（例如删除现有条目或无需实际运行迁移就插入新条目），请使用migration repair命令。

使用--dry-run参数可在应用前预览变更列表。

将本地数据库重置为初始状态。

需要先通过运行supabase start启动本地开发环境。

会重新创建本地Postgres容器，并应用supabase/migrations目录中的所有本地迁移。如果supabase/seed.sql中定义了测试数据，将在迁移完成后进行播种。本地开发期间所做的任何其他数据或模式更改都将被丢弃。

当使用--linked或--db-url标志运行db reset时，会执行SQL脚本来识别并删除远程数据库中所有用户创建的实体。由于Postgres角色是集群级实体，通过仪表板或supabase/roles.sql创建的任何自定义角色不会被远程重置删除。

从远程数据库转储内容。

需要通过运行supabase link将本地项目链接到远程数据库。对于自托管数据库，可以使用--db-url标志传入连接参数。

在容器中运行pg_dump，并带有额外的标志以排除Supabase管理的模式。被忽略的模式包括auth、storage以及由扩展创建的模式。

默认转储不包含任何数据或自定义角色。要明确转储这些内容，请指定--data-only或--role-only标志。

比较对本地或远程数据库所做的模式变更。

与本地数据库比较时，需要本地开发堆栈正在运行。要与远程或自托管数据库比较，请分别指定--linked或--db-url标志。

在容器中运行djrobstep/migra来比较目标数据库与影子数据库之间的模式差异。影子数据库是通过在单独的容器中应用本地supabase/migrations目录中的迁移创建的。默认情况下，输出会写入stdout。为了方便起见，您还可以通过传入-f标志将模式差异保存为新的迁移文件。

默认情况下，会比较目标数据库中的所有模式。使用--schema public,extensions标志可以将比较限制为模式的子集。

虽然diff命令能够捕获大多数模式变更，但在某些情况下已知会失败。目前，如果您的模式包含以下内容，可能会发生这种情况：

• 对发布的变更
• 对存储桶的变更
• 具有security_invoker属性的视图

对本地数据库进行模式错误检查。

当针对本地数据库进行检查时，需要本地开发环境正在运行。若要对远程或自托管数据库进行检查，请分别指定--linked或--db-url标志。

在本地Postgres容器中运行plpgsql_check扩展，检查所有模式中的错误。默认检查级别为warning，可通过--level标志提升至error级别。

若仅检查特定模式，请传入--schema标志。

--fail-on标志可用于控制命令何时以非零状态码退出。可选值包括：

• none（默认）：无论检查结果如何，始终以零状态码退出。
• warning：发现警告或错误时以非零状态码退出。
• error：仅发现错误时以非零状态码退出。

该标志在CI/CD管道中特别有用，您可以根据特定检查条件使构建失败。

在本地创建一个新的迁移文件。

如果当前workdir中不存在supabase/migrations目录，将会自动创建该目录。所有模式迁移文件都必须按照<时间戳>_<名称>.sql的命名格式存放在此目录下。

其他命令（如db diff）的输出可以通过标准输入管道传递给migration new <名称>命令。

列出本地和远程数据库中的迁移历史。

需要先通过运行supabase link命令将本地项目链接到远程数据库。对于自托管数据库，可以使用--db-url标志传入连接参数。

注意URL字符串必须按照RFC 3986规范进行编码。

本地迁移存储在supabase/migrations目录中，而远程迁移记录在supabase_migrations.schema_migrations表中。仅通过时间戳比较来识别差异。

当本地与远程迁移历史存在差异时，可以使用migration repair命令进行修复。

修复远程迁移历史表。

要求通过运行supabase link将本地项目链接到远程数据库。

如果本地和远程迁移历史不同步，您可以通过将特定迁移标记为--status applied或--status reverted来修复远程历史。标记为reverted将从迁移历史表中删除现有记录，而标记为applied将插入新记录。

例如，您的迁移历史可能如下表所示，本地或远程缺少条目。

$ supabase migration list
        本地      │     远程      │     时间 (UTC)
  ─────────────────┼────────────────┼──────────────────────
                   │ 20230103054303 │ 2023-01-03 05:43:03
   20230103054315  │                │ 2023-01-03 05:43:15

要将迁移历史重置为干净状态，首先删除本地迁移文件。

$ rm supabase/migrations/20230103054315_remote_commit.sql

$ supabase migration list
        本地      │     远程      │     时间 (UTC)
  ─────────────────┼────────────────┼──────────────────────
                   │ 20230103054303 │ 2023-01-03 05:43:03

然后将远程迁移20230103054303标记为已恢复。

$ supabase migration repair 20230103054303 --status reverted
正在连接到远程数据库...
已修复迁移历史: [20220810154537] => 已恢复
完成 supabase migration repair。

$ supabase migration list
        本地      │     远程      │     时间 (UTC)
  ─────────────────┼────────────────┼──────────────────────

现在您可以再次运行db pull将远程架构转储为本地迁移文件。

$ supabase db pull
正在连接到远程数据库...
架构已写入 supabase/migrations/20240414044403_remote_schema.sql
更新远程迁移历史表? [Y/n]
已修复迁移历史: [20240414044403] => 已应用
完成 supabase db pull。

$ supabase migration list
        本地      │     远程      │     时间 (UTC)
  ─────────────────┼────────────────┼──────────────────────
    20240414044403 │ 20240414044403 │ 2024-04-14 04:44:03

将本地模式迁移压缩为单个迁移文件。

压缩后的迁移相当于在应用现有迁移文件后，对本地数据库进行仅模式转储。这在您希望从迁移历史中移除对同一模式的重复修改时特别有用。

然而，一个限制是数据操作语句（如插入、更新或删除）会从压缩迁移中省略。您需要在新迁移文件中手动添加这些内容。这包括定时任务、存储桶和金库中的任何加密密钥。

默认情况下，最新的 <时间戳>_<名称>.sql 文件将被更新以包含压缩后的迁移。您可以使用 --version <时间戳> 标志覆盖目标版本。

如果您的 supabase/migrations 目录为空，运行 supabase squash 将不会执行任何操作。

此命令类似于 supabase inspect db outliers 命令，但按语句调用次数排序。

您可以使用此信息查看哪些查询被调用最频繁，这些查询可能是优化的潜在候选对象。

                        查询语句                      │ 总执行时间  │ 占总执行时间的比例 │ 调用次数 │  同步IO时间
  ─────────────────────────────────────────────────┼─────────────┼────────────────────┼──────────┼──────────────
    SELECT * FROM users WHERE id = $1              │ 14:50:11.828939      │ 89.8%             │ 183,389,757 │ 00:00:00.002018
    SELECT * FROM user_events                      │ 01:20:23.466633      │ 1.4%              │     78,325 │ 00:00:00
    INSERT INTO users (email, name) VALUES ($1, $2)│ 00:40:11.616882      │ 0.8%              │     54,003 │ 00:00:00.000322

此命令显示当前运行时间超过5分钟的查询，按持续时间降序排列。长时间运行的查询可能导致多种问题，例如阻止DDL语句完成或使vacuum操作无法更新relfrozenxid。

  PID  │     持续时间     │                                         查询语句
───────┼─────────────────┼───────────────────────────────────────────────────────────────────────────────────────
 19578 | 02:29:11.200129 | EXPLAIN SELECT  "students".* FROM "students"  WHERE "students"."id" = 1450645 LIMIT 1
 19465 | 02:26:05.542653 | EXPLAIN SELECT  "students".* FROM "students"  WHERE "students"."id" = 1889881 LIMIT 1
 19632 | 02:24:46.962818 | EXPLAIN SELECT  "students".* FROM "students"  WHERE "students"."id" = 1581884 LIMIT 1

此命令显示从pg_stat_statements获取的语句，按聚合执行时间排序。包括语句本身、该语句的总执行时间、该语句占所有语句总执行时间的比例、该语句的调用次数，以及该语句在同步I/O（文件系统读写）上花费的时间。

通常，高效查询的调用次数与总执行时间之比应适当，且尽可能减少I/O时间。对于总执行时间长但调用次数少的查询应进行调查以提升性能。同步I/O占用执行时间比例高的查询也应进行调查。

                 查询语句                  │ 执行时间        │ 执行时间占比          │ 调用次数      │ 同步I/O时间
─────────────────────────────────────────┼──────────────────┼─────────────────────────┼──────────────┼───────────────
 SELECT * FROM archivable_usage_events.. │ 154:39:26.431466 │ 72.2%                   │ 34,211,877   │ 00:00:00
 COPY public.archivable_usage_events (.. │ 50:38:33.198418  │ 23.6%                   │ 13           │ 13:34:21.00108
 COPY public.usage_events (id, reporte.. │ 02:32:16.335233  │ 1.2%                    │ 13           │ 00:34:19.784318
 INSERT INTO usage_events (id, retaine.. │ 01:42:59.436532  │ 0.8%                    │ 12,328,187   │ 00:00:00
 SELECT * FROM usage_events WHERE (alp.. │ 01:18:10.754354  │ 0.6%                    │ 102,114,301  │ 00:00:00

此命令显示当前持有锁并造成阻塞的语句，以及被阻塞的语句。可与inspect db locks命令配合使用，以确定需要终止哪些语句来解决锁争用问题。

    被阻塞PID │ 阻塞语句                     │ 阻塞时长         │ 阻塞PID      │ 被阻塞语句                                                                              │ 被阻塞时长
  ──────────────┼──────────────────────────────┼───────────────────┼──────────────┼────────────────────────────────────────────────────────────────────────────────────────┼───────────────────
    253         │ select count(*) from mytable │ 00:00:03.838314   │        13495 │ UPDATE "mytable" SET "updated_at" = '2023─08─03 14:07:04.746688' WHERE "id" = 83719341 │ 00:00:03.821826

此命令显示已对关系获取独占锁的查询。独占锁通常会阻止对该关系的其他操作，并可能导致“挂起”查询等待锁被授予。

如果发现某个查询长时间挂起或导致阻塞问题，可以考虑通过连接到数据库并运行SELECT pg_cancel_backend(PID);来取消该查询。如果查询仍未停止，可以通过运行SELECT pg_terminate_backend(PID);强制终止。

     PID   │ RELNAME │ TRANSACTION ID │ GRANTED │                  QUERY                  │   AGE
  ─────────┼─────────┼────────────────┼─────────┼─────────────────────────────────────────┼───────────
    328112 │ null    │              0 │ t       │ SELECT * FROM logs;                     │ 00:04:20

此命令显示数据库中所有索引的总大小。计算方法是将页数（由relpages报告）乘以页面大小（8192字节）。

    大小
  ─────────
    12 MB

此命令显示数据库中每个索引的大小。计算方式是将页数（由relpages报告）乘以页面大小（8192字节）。

              名称              │    大小
  ──────────────────────────────┼─────────────
    user_events_index           │ 2082 MB
    job_run_details_pkey        │ 3856 kB
    schema_migrations_pkey      │ 16 kB
    refresh_tokens_token_unique │ 8192字节
    users_instance_id_idx       │ 0字节
    buckets_pkey                │ 0字节

该命令提供索引效率信息，以索引扫描占总扫描次数的百分比表示。低百分比可能表明索引不足或索引了错误数据。

       表名          │       索引使用百分比       │   表行数
  ────────────────────┼────────────────────────────┼───────────────
    user_events       │                         99 │     4225318 
    user_feed         │                         99 │     3581573
    unindexed_table   │                          0 │      322911
    job               │                        100 │       33242
    schema_migrations │                         97 │           0
    migrations        │ 数据不足                   │           0

此命令显示扫描次数少于50次且大小超过5页的索引，并按相对于索引扫描次数的大小排序。该命令通常用于发现未使用的索引。索引会影响写入性能，如果它们占用内存空间，也会影响读取性能，因此删除不需要或未使用的索引是一个好主意。

        表名         │                   索引名                   │ 索引大小   │ 索引扫描次数
─────────────────────┼────────────────────────────────────────────┼────────────┼──────────────
 public.users        │ user_id_created_at_idx                     │ 97 MB      │           0

此命令显示数据库中每个表的总大小。它是每个表的pg_table_size()和pg_indexes_size()返回值之和。不包括pg_catalog和information_schema中的系统表。

                名称              │    大小
───────────────────────────────────┼─────────────
  job_run_details                  │ 395 MB
  slack_msgs                       │ 648 kB
  emails                           │ 640 kB

此命令显示数据库中每个表的大小。它是通过使用系统管理函数pg_table_size()计算的，该函数包括主数据分支、空闲空间映射、可见性映射和TOAST数据的大小。不包括表的索引大小。

                  名称               │    大小
  ───────────────────────────────────┼─────────────
    job_run_details                  │ 385 MB
    emails                           │ 584 kB
    job                              │ 40 kB
    sessions                         │ 0 字节
    prod_resource_notifications_meta │ 0 字节

此命令显示每个表索引的总大小。它是通过使用系统管理函数pg_indexes_size()计算的。

                 表名               │ 索引大小
  ───────────────────────────────────┼─────────────
    job_run_details                  │ 10104 kB
    users                            │ 128 kB
    job                              │ 32 kB
    instances                        │ 8192 字节
    http_request_queue               │ 0 字节

该命令提供关于缓冲缓存效率的信息，以及您的查询必须访问磁盘而非从内存读取的频率。同时显示索引读取（index hit rate）和表读取（table hit rate）的信息。通常，缓存命中率低的数据库性能较差，因为从磁盘读取数据比从内存检索要慢。如果您的表命中率较低，这可能表明您的RAM不足，升级到具有更多内存的更大计算插件可能会有所帮助。如果您的索引命中率较低，这可能表明有添加更合适索引的空间。

命中率计算为从Postgres缓冲缓存获取的表或索引块数与从磁盘读取的缓存块和未缓存块之和的比率。

在较小的计算计划（免费、小型、中型）上，低于99%的比率可能表明存在问题。在较大的计划上，命中率可能较低，但性能将保持稳定，因为数据可能使用操作系统缓存而非Postgres缓冲缓存。

         名称      │  比率
  ─────────────────┼───────────
    索引命中率 │ 0.996621
    表命中率 │ 0.999341

此命令显示每个表的预估行数，按预估数量降序排列。预估数量来源于n_live_tup，该值由vacuum操作更新。由于n_live_tup的填充方式，稀疏页与密集页可能导致预估数量与实际行数存在显著差异。

       表名      │ 预估行数
  ─────────────┼──────────────────
    logs       │          322943
    emails     │            1103
    job        │               1
    migrations │               0

此命令显示所有表记录的顺序扫描次数，按顺序扫描次数降序排列。顺序扫描次数非常高的表可能索引不足，值得调查从这些表读取的查询。

                  名称               │ 次数
  ───────────────────────────────────┼─────────
    电子邮件                          │ 182435
    用户                             │  25063
    作业运行详情                      │     60
    架构迁移                         │      0
    迁移记录                         │      0

此命令显示数据库中设置的逻辑复制槽信息。它会显示槽是否活跃、WAL发送进程状态（'startup'、'catchup'、'streaming'、'backup'、'stopping'）、复制客户端地址以及以GB为单位的复制延迟量。

该命令可用于检查复制延迟量是否尽可能低，复制延迟可能由网络延迟问题、磁盘I/O缓慢、长时间运行的事务或订阅者无法足够快地消费WAL引起。

                       名称                    │ 活跃 │ 状态   │ 复制客户端地址 │ 复制延迟 GB
  ─────────────────────────────────────────────┼──────┼─────────┼────────────────┼───────────────
    supabase_realtime_replication_slot         │ 是   │ 不适用 │ 不适用         │             0
    datastream                                 │ 是   │ 追赶中 │ 24.201.24.106  │            45

此命令显示每个数据库角色的活跃连接数，以便查看哪个特定角色可能消耗了超出预期的连接数。

这是Supabase特有的命令。您也可以在仪表板上查看此细分： https://app.supabase.com/project/_/database/roles

最大活跃连接数取决于您的实例大小。您可以手动覆盖允许的连接数，但不建议这样做。

            角色名称         │ 活跃连接数
  ────────────────────────────┼───────────────────
    authenticator             │                5
    postgres                  │                5
    supabase_admin            │                1
    pgbouncer                 │                1
    anon                      │                0
    authenticated             │                0
    service_role              │                0
    dashboard_user            │                0
    supabase_auth_admin       │                0
    supabase_storage_admin    │                0
    supabase_functions_admin  │                0
    pgsodium_keyholder        │                0
    pg_read_all_data          │                0
    pg_write_all_data         │                0
    pg_monitor                │                0

活跃连接数 12/90

此命令显示表的"膨胀"估算值 - 由于Postgres的MVCC机制，当数据被更新或删除时，会创建新行并将旧行标记为不可见的"死元组"。通常自动清理进程会异步清理这些死元组。但有时自动清理速度不够快，无法减少或防止表膨胀。高膨胀率会降低查询速度、导致过度IOPS并浪费数据库空间。

对于膨胀率高的表应进行调查，查看是否存在清理速度不足或其他问题。

    类型  │ 模式名称   │        对象名称          │ 膨胀率 │ 浪费空间
  ────────┼─────────────┼────────────────────────────┼───────┼─────────────
    表    │ public      │ very_bloated_table         │  41.0 │ 700 MB
    表    │ public      │ my_table                   │   4.0 │ 76 MB
    表    │ public      │ happy_table                │   1.0 │ 1472 kB
    索引  │ public      │ happy_table::my_nice_index │   0.7 │ 880 kB

此命令显示每个表的 vacuum 活动统计信息。由于Postgres的MVCC机制，当数据被更新或删除时，会创建新行并将旧行标记为不可见的"死元组"。通常autovaccum进程会异步清理这些死元组。

该命令列出最后一次手动vacuum和自动vacuum的时间、表的行数、死行数以及是否预期会运行自动vacuum。如果死行数远高于行数，或者预期会运行自动vacuum但长时间未执行，这可能表明自动vacuum无法跟上节奏，需要调整vacuum设置或增加计算资源/磁盘IOPS以使自动vacuum能够完成。

        模式          │              表名               │ 最后手动VACUUM │ 最后自动VACUUM │        行数        │    死行数     │ 预期自动VACUUM?
──────────────────────┼──────────────────────────────────┼─────────────┼──────────────────┼──────────────────────┼────────────────┼─────────────────────
 auth                 │ users                            │             │ 2023-06-26 12:34 │               18,030 │              0 │ 否
 public               │ profiles                         │             │ 2023-06-26 23:45 │               13,420 │             28 │ 否
 public               │ logs                             │             │ 2023-06-26 01:23 │            1,313,033 │      3,318,228 │ 是
 storage              │ objects                          │             │                  │             无统计信息 │              0 │ 否
 storage              │ buckets                          │             │                  │             无统计信息 │              0 │ 否
 supabase_migrations  │ schema_migrations                │             │                  │             无统计信息 │              0 │ 否

为已登录用户创建一个组织。

列出登录用户所属的所有组织。

提供用于创建和管理Supabase项目的工具。

此命令组允许您列出组织中的所有项目、创建新项目、删除现有项目以及检索API密钥。这些操作帮助您以编程方式管理Supabase基础设施，而无需使用仪表板。

通过CLI进行项目管理对于自动化脚本特别有用，当您需要以可重复的方式配置环境时。

列出登录用户可以访问的所有Supabase项目。

使用本地的 supabase/config.toml 文件更新已链接的 Supabase 项目配置。

该命令允许您通过本地定义设置，然后将其推送到远程项目，实现项目配置的代码化管理。

为关联项目创建预览分支。

列出关联项目的所有预览分支。

检索指定预览分支的详细信息。

通过名称或ID更新预览分支。

通过名称或ID删除预览分支

为关联项目禁用预览分支功能。

管理Supabase边缘函数。

Supabase边缘函数是靠近用户运行的无服务器函数。

边缘函数允许您执行自定义服务器端代码，而无需部署或扩展传统服务器。它们非常适合处理webhook、自定义API端点、数据验证和提供个性化内容。

边缘函数使用TypeScript编写，并在Deno兼容的边缘运行时上运行，这是一个安全的运行时，无需包管理，冷启动快速，并具有内置安全性。

在supabase/functions目录中创建一个带有样板代码的新边缘函数。

此命令会生成一个包含必要Deno导入和基本函数结构的TypeScript入门文件。函数将以您指定的名称创建为一个新目录，其中包含带有函数代码的index.ts文件。

创建函数后，您可以在本地编辑它，然后使用supabase functions serve进行测试，最后通过supabase functions deploy部署。

列出关联Supabase项目中的所有函数。

从关联的 Supabase 项目下载函数的源代码。

在本地运行所有函数。

supabase functions serve 命令包含额外标志，可通过v8检查器协议帮助开发者调试边缘函数，支持通过Chrome DevTools、VS Code和IntelliJ IDEA等工具进行调试。具体设置方法请参阅文档指南。

1. --inspect

   • --inspect-mode brk的别名

2. --inspect-mode [ run | brk | wait ]

   • 激活检查器功能
   • run模式仅允许建立连接而不附加其他行为。不适合短脚本，但对长期运行的脚本偶尔设置断点时有用
   • brk模式与run模式相同，但会在首行设置断点，在代码执行前暂停脚本
   • wait模式类似brk模式，但不设置首行断点，而是等待检查器会话连接后才继续执行

3. --inspect-main

   • 需配合上述任一标志使用
   • 默认禁止为主工作线程创建检查器会话，此标志可解除限制
   • 其他行为遵循上述inspect-mode标志

此外，可通过supabase/config.toml文件中edge_runtime节自定义以下属性：

1. inspector_port
   • 监听检查器会话的端口，默认8083
2. policy
   • 控制边缘运行时如何转发HTTP请求到工作线程
   • per_worker允许多个请求转发至已创建的工作线程
   • oneshot强制工作线程处理单个请求后立即退出（调试专用，即时反映代码修改时特别有用）

将函数部署到关联的Supabase项目

从关联的 Supabase 项目中删除一个函数。此操作不会在本地移除该函数。

提供工具用于管理您的Supabase项目的环境变量和机密信息。

此命令组允许您设置、删除和列出安全存储的机密信息，这些信息将作为环境变量提供给边缘函数使用。

通过CLI进行机密管理适用于：

• 设置特定环境配置
• 安全管理敏感凭证

为方便起见，可以单独设置机密或从.env文件加载。

为关联的Supabase项目设置一个或多个密钥。

列出链接项目中的所有密钥。

从关联的Supabase项目中删除一个或多个机密信息。

为您的Supabase项目添加并配置一个新的SSO身份提供商连接。

列出与您的 Supabase 项目连接的所有 SSO 身份提供商。

提供有关与身份提供者建立的连接的信息。您可以使用--metadata获取存储在项目配置中的原始SAML 2.0元数据XML文档。

返回项目注册到兼容SAML 2.0身份提供商所需的所有重要SSO信息。

更新已添加的SSO身份提供商的配置设置。

移除已添加的 SSO 身份提供程序连接。移除提供程序将阻止现有用户登录。请谨慎使用此命令。

管理Supabase项目的自定义域名。

自定义域名与个性化子域名的使用是互斥的。

为项目启用自定义域名配置。

此操作将重新配置您的 Supabase 项目，使其响应自定义域名上的请求。

激活自定义域名后，您项目的第三方身份验证提供商将不再在 Supabase 提供的子域名上运行。请参阅文档中的准备激活您的域名部分，了解需要遵循的步骤详情。

为您的Supabase项目创建自定义主机名。

期望您的自定义主机名具有指向Supabase项目子域的CNAME记录。

获取项目中存储的自定义主机名配置，该配置保存在Supabase平台中。

管理 Supabase 项目的自定义子域名。

自定义子域名与自定义域名的使用互斥。

为您的Supabase项目激活自定义子域名。

这将重新配置您的Supabase项目，使其响应自定义子域名上的请求。 自定义子域名激活后，您项目的认证服务将不再在{project-ref}.{supabase-domain}主机名上运行。

删除项目的自定义子域名，并恢复使用项目引用进行路由。

网络封禁是指那些因流量模式看起来具有滥用性（例如多次认证失败尝试）而被临时封锁的IP地址。

子命令可帮助您查看当前封禁情况，并在需要时解除对IP的封锁。

覆盖默认的 Postgres 配置可能导致数据库行为不稳定。 自定义配置还会覆盖基于所使用的计算附加组件生成的优化配置。

删除特定的配置覆盖项，将其恢复为默认值。

列出关联项目的所有SQL代码片段

下载指定 SQL 代码片段的内容。

为指定的shell生成supabase的自动补全脚本。 有关如何使用生成的脚本的详细信息，请参阅每个子命令的帮助。

为zsh shell生成自动补全脚本。

如果您的环境中尚未启用shell自动补全功能，您需要先启用它。您可以执行以下命令一次：

echo "autoload -U compinit; compinit" >> ~/.zshrc

要在当前shell会话中加载自动补全功能：

source <(supabase completion zsh)

要为每个新会话加载自动补全功能，请执行一次以下命令：

Linux系统：

supabase completion zsh > "${fpath[1]}/_supabase"

macOS系统：

supabase completion zsh > $(brew --prefix)/share/zsh/site-functions/_supabase

您需要启动一个新的shell才能使此设置生效。

生成PowerShell的自动补全脚本。

要在当前shell会话中加载补全：

supabase completion powershell | Out-String | Invoke-Expression

要为每个新会话加载补全，请将上述命令的输出 添加到您的PowerShell配置文件中。

生成fish shell的自动补全脚本。

要在当前shell会话中加载补全：

supabase completion fish | source

要为每个新会话加载补全，请执行一次：

supabase completion fish > ~/.config/fish/completions/supabase.fish

您需要启动一个新的shell才能使此设置生效。

为bash shell生成自动补全脚本。

该脚本依赖'bash-completion'包。 如果尚未安装，您可以通过操作系统的包管理器进行安装。

在当前shell会话中加载补全功能：

source <(supabase completion bash)

要为每个新会话永久加载补全功能，请执行一次以下命令：

Linux系统：

supabase completion bash > /etc/bash_completion.d/supabase

macOS系统：

supabase completion bash > $(brew --prefix)/etc/bash_completion.d/supabase

此设置需要重新启动新的shell才能生效。