Class SupabaseDatabase

integrations/supabase/src/management/index.ts:46–266

    };

class SupabaseDatabase<Database = any> {
  constructor(
    private integration: SupabaseManagement,
    private projectRef: string
  ) {}

  /**
   * The function `on` creates a trigger for when a record is inserted, updated, or deleted on a
   * specific table in a database schema.
   * @param params - The `params` parameter is an object that contains the following properties:
   * @param params.table - The `table` property is a string that specifies the name of the table
   * that the trigger will be created for.
   * @param params.events - The `events` property is an array of events that specifies the events
   * that the trigger will be called for. The events that can be specified are `INSERT`, `UPDATE`, or `DELETE`.
   * By default, the trigger will be called for all events.
   * @param params.schema - The `schema` property is a string that specifies the name of the schema
   * that the trigger will be created for. If the schema is not specified, the default schema will
   * be used. (public)
   * @param params.filter - The `filter` property is an object that specifies the filter that will
   * be used to determine if the trigger should be called. If the filter is not specified, the
   * trigger will be called for all records.
   *
   * @example
   *
   * ```ts
   * const supabase = new SupabaseManagement({ id: "supabase" });
   * const database = supabase.database<Database>("https://<project-id>.supabase.co");
   *
   * client.defineJob({
   *  trigger: database.on({
   *    table: "todos",
   *    events: ["INSERTED", "UPDATED"],
   *    schema: "public",
   *    filter: {
   *     record: { is_completed: [false] },
   *    },
   *  }),
   * })
   * ```
   */
  on<
    SchemaName extends string & keyof Database = "public" extends keyof Database
      ? "public"
      : string & keyof Database,
    Schema extends GenericSchema = Database[SchemaName] extends GenericSchema
      ? Database[SchemaName]
      : any,
    TTableName extends string & keyof Schema["Tables"] = string & keyof Schema["Tables"],
    TTable extends Schema["Tables"][TTableName] = Schema["Tables"][TTableName],
    TEvents extends WebhookEvents[] = ["INSERT", "UPDATE", "DELETE"],
  >(params: { table: TTableName; events?: TEvents; schema?: SchemaName; filter?: EventFilter }) {
    return createTrigger<Prettify<UnionPayloads<TEvents, TTableName, SchemaName, TTable["Row"]>>>(
      this.integration.source,
      {
        event: params.events ?? ["INSERT", "UPDATE", "DELETE"],
        projectRef: this.projectRef,
        ...params,
      }