Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): minor doc corrections for consistency #211

Merged
merged 1 commit into from
Jan 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,17 @@
code = {
"url: jdbc:arrow-flight-sql://localhost:31010/?useEncryption=false",
"username: db_user",
"password: db_password",
"password: db_passwd",
"sql: select * FROM departments",
"fetch: true",
}
),
@Example(
title = "Send a sql query to a Dremio coordinator and fetch rows as outputs using Apache Arrow Flight SQL driver.",
title = "Send a SQL query to a Dremio coordinator and fetch rows as outputs using Apache Arrow Flight SQL driver.",
code = {
"url: jdbc:arrow-flight-sql://dremio-coordinator:32010/?schema=postgres.public",
"username: dremio_user",
"password: dremio_password",
"password: dremio_passwd",
"sql: select * FROM departments",
"fetch: true",
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
" - id: watch",
" type: io.kestra.plugin.jdbc.arrowflight.Trigger",
" username: dremio_user",
" password: dremio_password",
" password: dremio_passwd",
" url: jdbc:arrow-flight-sql://dremio-coordinator:32010/?schema=postgres.public",
" interval: \"PT5M\"",
" sql: \"SELECT * FROM my_table\"",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
@PluginSubGroup(
description = "This sub-group of plugins contains tasks for accessing a databases through Apache Arrow Flight SQL.",
description = "This sub-group of plugins contains tasks for accessing a database through Apache Arrow Flight SQL.",
categories = PluginSubGroup.PluginCategory.DATABASE
)
package io.kestra.plugin.jdbc.arrowflight;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
@Plugin(
examples = {
@Example(
title = "Send a sql query to a Clickhouse database and fetch a row as output.",
title = "Send a SQL query to a Clickhouse database and fetch a row as output.",
code = {
"url: jdbc:clickhouse://127.0.0.1:56982/",
"username: ch_user",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
@Plugin(
examples = {
@Example(
title = "Send a sql query to a MySQL Database and fetch a row as output.",
title = "Send a SQL query to a MySQL Database and fetch a row as output.",
code = {
"url: jdbc:mysql://127.0.0.1:3306/",
"username: mysql_user",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ public static class Output implements io.kestra.core.models.tasks.Output {
private final URI uri;

@Schema(
title = "The number of rows to be fetched.",
title = "The number of rows fetched.",
description = "Only populated if `store` or `fetch` parameter is set to true."
)
private final Long size;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

public interface JdbcQueryInterface extends JdbcStatementInterface {
@Schema(
title = "The sql query to run."
title = "The SQL query to run."
)
@PluginProperty(dynamic = true)
String getSql();

@Schema(
title = "Whether to fetch the data from the query result to the task output." +
" This parameter is evaluated after 'fetchOne' and 'store'."
" This parameter is evaluated after `fetchOne` and `store`."
)
@PluginProperty(dynamic = false)
boolean isFetch();
Expand All @@ -23,14 +23,14 @@ public interface JdbcQueryInterface extends JdbcStatementInterface {
" File will be saved as Amazon Ion (text format)." +
" \n" +
" See <a href=\"http://amzn.github.io/ion-docs/\">Amazon Ion documentation</a>" +
" This parameter is evaluated after 'fetchOne' but before 'fetch'."
" This parameter is evaluated after `fetchOne` but before `fetch`."
)
@PluginProperty(dynamic = false)
boolean isStore();

@Schema(
title = "Whether to fetch only one data row from the query result to the task output." +
" This parameter is evaluated before 'store' and 'fetch'."
" This parameter is evaluated before `store` and `fetch`."
)
@PluginProperty(dynamic = false)
boolean isFetchOne();
Expand Down
Loading