Skip to content

Commit 940507a

Browse files
committed
docs: add permissions section to project status and clarify future support for custom start functions (#278)
functions - Updated project status to include information about permissions and upcoming features - Clarified that pgflow currently has no built-in permissions and requires manual database configuration - Mentioned future support for custom start functions to enable authorization and multi-tenant scenarios in the TypeScript Client
1 parent 31f5e2c commit 940507a

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

pkgs/website/src/content/docs/project-status.mdx

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,21 @@ pgflow is in **public beta** and being used in production by early adopters. Cor
1212

1313
## Known Limitations & Active Work
1414

15-
<CardGrid>
16-
<Card title="Performance" icon="rocket">
17-
Core operations are optimized with batching, proper indexing, and declarative SQL. However, **large-scale workloads** may reveal additional optimization opportunities. Start with your expected workload and scale as needed.
18-
</Card>
15+
<Card title="Performance" icon="rocket">
16+
Core operations are optimized with batching, proper indexing, and declarative SQL. However, **large-scale workloads** may reveal additional optimization opportunities. Start with your expected workload and scale as needed.
17+
</Card>
1918

20-
<Card title="Worker Management" icon="setting">
21-
Edge Functions have platform execution time limits. For production reliability, set up a **pg_cron job** to automatically restart workers when needed. See [deployment guide](/deploy/supabase/keep-workers-running/) for the simple 2-minute setup.
22-
</Card>
19+
<Card title="Worker Management" icon="setting">
20+
Edge Functions have platform execution time limits. For production reliability, set up a **pg_cron job** to automatically restart workers when needed. See [deployment guide](/deploy/supabase/keep-workers-running/) for the simple 2-minute setup.
21+
</Card>
2322

24-
<Card title="Fair Processing" icon="warning">
25-
Fair processing across flows is not currently implemented. A flow with many tasks (especially map steps processing large arrays) can fill the queue ahead of other flows. This is more noticeable with the introduction of map steps in 0.7.0. For multi-tenant or multi-flow scenarios where fairness is important, join [Discord](https://pgflow.dev/discord/) to discuss approaches and workarounds.
26-
</Card>
27-
</CardGrid>
23+
<Card title="Fair Processing" icon="warning">
24+
Fair processing across flows is not currently implemented. A flow with many tasks (especially map steps processing large arrays) can fill the queue ahead of other flows. This is more noticeable with the introduction of map steps in 0.7.0. For multi-tenant or multi-flow scenarios where fairness is important, join [Discord](https://pgflow.dev/discord/) to discuss approaches and workarounds.
25+
</Card>
26+
27+
<Card title="Permissions" icon="approve-check">
28+
pgflow ships with zero built-in permissions or access controls. [Database permissions](/reference/permissions/) must be manually configured when using the TypeScript Client or Supabase RPC from client applications. In a future release, pgflow will support custom start functions for the TypeScript Client, enabling authorization logic at the database level and supporting multi-tenant scenarios.
29+
</Card>
2830

2931
## Breaking Changes
3032

pkgs/website/src/content/docs/reference/permissions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ supabase migration up
8585

8686
With **[Supabase RPC](/build/starting-flows/supabase-rpc/)**, you have full control - wrap `pgflow.start_flow` in your own database functions to implement custom permissions and security logic.
8787

88-
In a future release, pgflow will support **custom start functions** for the TypeScript Client, allowing you to implement authorization logic at the database level.
88+
In a future release, pgflow will support **custom start functions** for the TypeScript Client, allowing you to implement authorization logic at the database level and enabling multi-tenant scenarios where runs can be associated with specific users or tenants.
8989

9090
## Learn More
9191

0 commit comments

Comments
 (0)