Supabase
Supabase projects for Sanoma, through the OpenTofu provider and the Management API.
Package @sanoma-ai/connector-supabase, version 0.11.24. Its README, with how to install and connect it, is on GitHub.
Resource types, which a data file under resources/ declares: supabase.project.
project
import
Find a project by its binding id and read it; gone when there is none
Input
- idstringrequired
at least 1 character
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- database_passwordstring | null
Password for the project database
- idstring | null
Project identifier
- instance_sizestring | null
Desired instance size of the project
- legacy_api_keys_enabledboolean | nulldeprecated
Controls whether
anonandservice_roleJWT-based api keys should be enabled. Please note: these keys are no longer recommended ([more information here](https://supabase.com/docs/guides/api/api-keys#why-are-anon-and-servicerole-jwt-based-keys-no-longer-recommended)). - namestringrequired
Name of the project
- organization_idstringrequired
Organization slug (found in the Supabase dashboard URL or organization settings)
- regionstringrequired
Region where the project is located
- timeoutsobject | null
Fields
- createstring | null
A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- updatestring | null
A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- createstring | null
- database_passwordstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
read
Read a project as it is now; gone when it no longer exists
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonebooleanrequired
- stateobject
Fields
- database_passwordstring | null
Password for the project database
- idstring | null
Project identifier
- instance_sizestring | null
Desired instance size of the project
- legacy_api_keys_enabledboolean | nulldeprecated
Controls whether
anonandservice_roleJWT-based api keys should be enabled. Please note: these keys are no longer recommended ([more information here](https://supabase.com/docs/guides/api/api-keys#why-are-anon-and-servicerole-jwt-based-keys-no-longer-recommended)). - namestringrequired
Name of the project
- organization_idstringrequired
Organization slug (found in the Supabase dashboard URL or organization settings)
- regionstringrequired
Region where the project is located
- timeoutsobject | null
Fields
- createstring | null
A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- updatestring | null
A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- createstring | null
- database_passwordstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
plan
Plan how apply would make a project match its declaration (or delete it, given none); nothing changes
Input
- idstring
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of any
The declared fields; a write-only one may hold a secret marker
Output
- action"none" | "create" | "update" | "replace" | "delete"required
- plannedrecord of any
- unknownstring[]required
- replacestring[]required
The fields whose change replaces the object: not empty exactly when
replace
create
Create a project as declared
Input
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- database_passwordstring | null
Password for the project database
- idstring | null
Project identifier
- instance_sizestring | null
Desired instance size of the project
- legacy_api_keys_enabledboolean | nulldeprecated
Controls whether
anonandservice_roleJWT-based api keys should be enabled. Please note: these keys are no longer recommended ([more information here](https://supabase.com/docs/guides/api/api-keys#why-are-anon-and-servicerole-jwt-based-keys-no-longer-recommended)). - namestringrequired
Name of the project
- organization_idstringrequired
Organization slug (found in the Supabase dashboard URL or organization settings)
- regionstringrequired
Region where the project is located
- timeoutsobject | null
Fields
- createstring | null
A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- updatestring | null
A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- createstring | null
- database_passwordstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
update
Change a project to match its declaration, replacing it where a field cannot change in place
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
- desiredrecord of anyrequired
The declared fields; a write-only one may hold a secret marker
- expectobject
Fields
- action"none" | "create" | "update" | "replace" | "delete"required
- replacestring[]required
Output
- idstringrequired
at least 1 character
- stateobjectrequired
Fields
- database_passwordstring | null
Password for the project database
- idstring | null
Project identifier
- instance_sizestring | null
Desired instance size of the project
- legacy_api_keys_enabledboolean | nulldeprecated
Controls whether
anonandservice_roleJWT-based api keys should be enabled. Please note: these keys are no longer recommended ([more information here](https://supabase.com/docs/guides/api/api-keys#why-are-anon-and-servicerole-jwt-based-keys-no-longer-recommended)). - namestringrequired
Name of the project
- organization_idstringrequired
Organization slug (found in the Supabase dashboard URL or organization settings)
- regionstringrequired
Region where the project is located
- timeoutsobject | null
Fields
- createstring | null
A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- updatestring | null
A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- createstring | null
- database_passwordstring | null
- handlestring
The driver's data for the object, opaque: pass it back unchanged
delete
Delete a project; done already when it is gone
Input
- idstringrequired
at least 1 character
- staterecord of any
- handlestring
The driver's data for the object, opaque: pass it back unchanged
Output
- idstringrequired
at least 1 character
- gonetruerequired
health
Read whether a project's services are healthy: its database and pooler unless others are named
Input
- refstringrequired
The project's ref
at least 1 character
- servicesstring[]
at least 1 item, each item: at least 1 character
Output
- healthybooleanrequired
- servicesobject[]required
Each item
- namestringrequired
- healthybooleanrequired
- statusstringrequired
organization
list
List the organizations the connection's token reaches: one for an OAuth grant
Input
object, with no fields.
Output
- organizationsobject[]required
Each item
- idstringrequired
- namestringrequired
pooler
get
Read the address of a project's session pooler (port 5432), which keeps LISTEN, unlike port 6543
Input
- refstringrequired
The project's ref
at least 1 character
Output
- hoststringrequired
- port5432required
- userstringrequired
- databasestringrequired
database
storeUrl
Store a project's database URL, through its session pooler with the password in SUPABASE_DB_PASSWORD, as the secret SANOMA_DATABASE_URL_<EXPORT>, never returned; refused when that secret holds another URL
Input
- refstringrequired
The project's ref
at least 1 character
- exportstringrequired
The data file's export that declares the project, such as
storematches ^[A-Za-z_][A-Za-z0-9_]*$
Output
- secretstringrequired
The secret's name, SANOMA_DATABASE_URL_<EXPORT>
These pages describe sanoma 0.11.24.