SurrealDB Query

SurrealDB Query

Certified

Run a SurrealDB query

Executes a SurrealQL statement against a SurrealDB database. Defaults to fetchType: STORE, which streams rows to internal storage; use FETCH or FETCH_ONE to surface rows directly. TLS is off by default; keep credentials in secrets.

yaml
type: io.kestra.plugin.surrealdb.Query

Send a SurrealQL query to a SurrealDB database.

yaml
id: surrealdb_query
namespace: company.team

tasks:
  - id: select
    type: io.kestra.plugin.surrealdb.Query
    useTls: true
    host: localhost
    port: 8000
    username: surreal_user
    password: "{{ secret('SURREALDB_PASSWORD') }}"
    database: surreal_db
    namespace: surreal_namespace
    query: SELECT * FROM SURREAL_TABLE
    fetchType: STORE
Properties
Min length1

Connection database

Min length1

Connection host

Min length1

Connection namespace

Min length1

SurrealQL query text

Default60
Minimum>

Connection timeout

Timeout for opening the connection in seconds; default is 60.

DefaultSTORE
Possible Values
STOREFETCHFETCH_ONENONE

Result handling mode

Controls how query results are returned. FETCH_ONE outputs the first row, FETCH outputs all rows, STORE writes rows to internal storage, NONE skips output creation.

Default{}

Named query parameters

SurrealQL prepared-statement parameters rendered before execution. Provide a map of named placeholders to values.

Plaintext authentication password

Reference (ref) of the pluginDefaults to apply to this task.

Default8000
Minimum>

Connection port

TCP port for the SurrealDB endpoint; default is 8000.

Defaultfalse

Enable TLS for connection

Use TLS when connecting to SurrealDB; default is false.

Plaintext authentication username

First fetched row

Populated only when fetchType: FETCH_ONE.

SubTypeobject

All fetched rows

Populated only when fetchType: FETCH.

Number of rows fetched

Formaturi

URI of stored result

Internal storage URI populated only when fetchType: STORE.

More Plugins in this Category

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks

PostgreSQL
PostgreSQL

Tasks that connect to PostgreSQL via JDBC to run queries and loads.

Data

6 tasks

25 blueprints