PluginsPlugin Surrealdb

Query​Query

Query a SurrealDB database with SurrealQL.

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: surreal_passwd
    database: surreal_db
    namespace: surreal_namespace
    query: SELECT * FROM SURREAL_TABLE
    fetchType: STORE
Properties
Min length 1

Connection database.

Min length 1

Connection host.

Min length 1

Connection namespace.

Min length 1

SurrealQL query to execute.

Default 60
Minimum >

Connection timeout. Default is 60 seconds.

Default STORE
Possible Values
STOREFETCHFETCH_ONENONE

The way you want to store data.

FETCH_ONE - output the first row. FETCH - output all rows as output variable. STORE - store all rows to a file. NONE - do nothing.

SubType string
Default {}

Query parameters, can be named parameters.

See SurrealDB documentation about SurrealQL Prepared Statements for query syntax.This should be supplied with a parameter map using named parameters.

Plaintext authentication password.

Default 8000
Minimum >

Connection port. Default value is 8000.

Default false

Specify whether to use TLS for connection. Default is false.

Plaintext authentication username.

Map containing the first row of fetched data.

Only populated if using fetchType: FETCH_ONE.

SubType object

List containing the fetched data.

Only populated if using fetchType: FETCH.

The number of rows fetched.

Format uri

The URI of the stored result in Kestra's internal storage.

Only populated if using fetchType: STORE.