EdgeDB

Databases DSN or connection details

Query an EdgeDB instance from any Windmill script, flow or app.

Set up in 3 steps

1

Get your credential

Either a DSN, or the host, port, database, user and password separately. A cloud instance uses its instance name and a secret key instead.

2

Add the resource in Windmill

Open Resources, add a resource of type edgedb, and fill it in.

3

Run your first script

Fork any script below and read before writing anything.

Scripts

Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.

Resource type

edgedb — the shape of the credential every script on this page expects.

View raw schema →
FieldTypeRequiredWhat it is
hoststringNoHostname of the EdgeDB instance. (Required unless a DSN or an EdgeDB Cloud instance are provided)
portnumberNo(Required unless a DSN or an EdgeDB Cloud instance are provided)
userstringNoUsername to use for connecting to the database. (Required unless a DSN or an EdgeDB Cloud instance are provided)
databasestringNoName of the database to connect to. (Required unless a DSN or an EdgeDB Cloud instance are provided)
passwordstringNo(Required unless a secret key for an EdgeDB Cloud instance is provided)
secretKeystringNoSpecifies the secret key to use for authentication with EdgeDB Cloud instances. (Required for EdgeDB Cloud instance)
instanceNamestringNoOnly for use with EdgeDB Cloud instances. Format is <github-username>/<instance-name> (Required for EdgeDB Cloud instances unless a DSN is provided)
dsnstringNoOverrides any other settings except password. (Required unless host, port, user, and database, or an EdgeDB Cloud instance name are provided)

Questions

DSN or separate fields?

Either. Fill the DSN alone, or the host, port, user, password and database — not both, since the DSN wins.

Is my credential stored on the hub?

Never. It lives only in your own Windmill workspace, encrypted at rest.