Query

type: "io.kestra.plugin.couchbase.Query"

Query a Couchbase database with N1QL.

Examples

Send a N1QL query to a Couchbase database.

id: "query"
type: "io.kestra.plugin.couchbase.Query"
connectionString: couchbase://localhost
username: couchbase_user
password: couchbase_passwd
query: SELECT * FROM `COUCHBASE_BUCKET`(.`COUCHBASE_SCOPE`.`COUCHBASE_COLLECTION`)
fetchType: FETCH

Properties

connectionString

• Type: string
• Dynamic: ✔️
• Required: ✔️
• Min length: 1

Connection string used to locate the Couchbase cluster.

fetchType

• Type: string
• Dynamic: ❌
• Required: ✔️
• Default: STORE
• Possible Values:
  • STORE
  • FETCH
  • FETCH_ONE
  • NONE

The way you want to fetch and/or store the data.

FETCH_ONE - output just the first row. FETCH - output all the rows. STORE - store all the rows in a file. NONE - do nothing.

password

• Type: string
• Dynamic: ✔️
• Required: ✔️
• Min length: 1

Plaintext authentication password.

query

• Type: string
• Dynamic: ✔️
• Required: ✔️
• Min length: 1

N1QL query to execute on Couchbase database.

username

• Type: string
• Dynamic: ✔️
• Required: ✔️
• Min length: 1

Plaintext authentication username.

parameters

• Type:
  • object
  • array
• SubType: string
• Dynamic: ✔️
• Required: ❌

Query parameters, can be positional or named parameters.

See Couchbase documentation about Prepared Statements for query syntax. This should be supplied with a parameter map if using named parameters, or an array for positional ones.

Outputs

row

• Type: object
• Required: ❌

Map containing the first row of fetched data.

Only populated if using FETCH_ONE.

rows

• Type: array
• SubType: object
• Required: ❌

List containing the fetched data.

Only populated if using FETCH.

size

• Type: integer
• Required: ❌

The number of rows to be fetched.

Only populated if fetchType is 'FETCH' or 'STORE'.

uri

• Type: string
• Required: ❌
• Format: uri

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

Only populated if using STORE.

Definitions