From e95cf615630c0bed5488b4942c94ff237b43db84 Mon Sep 17 00:00:00 2001 From: Eric P Green Date: Mon, 6 May 2024 15:15:19 -0700 Subject: [PATCH] Docs: update example Source YAML (#4842) --- docs/docs/reference/connectors/motherduck.md | 5 ++--- docs/docs/reference/connectors/mysql.md | 3 ++- docs/docs/reference/connectors/postgres.md | 3 ++- docs/docs/reference/connectors/salesforce.md | 3 ++- docs/docs/reference/connectors/sqlite.md | 5 ++--- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/docs/reference/connectors/motherduck.md b/docs/docs/reference/connectors/motherduck.md index 66940b491f8..98cbcb99967 100644 --- a/docs/docs/reference/connectors/motherduck.md +++ b/docs/docs/reference/connectors/motherduck.md @@ -28,11 +28,10 @@ If creating a new DuckDB source from the UI, you should pass in the appropriate On the other hand, if you are creating the source YAML file directly, the definition should look something like: ```yaml - -type: "duckdb" +type: "source" +connector: "duckdb" sql: "SELECT * from " db: "" - ``` :::tip If deploying to Rill Cloud diff --git a/docs/docs/reference/connectors/mysql.md b/docs/docs/reference/connectors/mysql.md index 41c2803708c..9200e66c539 100644 --- a/docs/docs/reference/connectors/mysql.md +++ b/docs/docs/reference/connectors/mysql.md @@ -38,7 +38,8 @@ Alternatively, you can include the connection string directly in the source YAML An example of a source using this approach: ```yaml -type: "mysql" +type: "source" +connector: "mysql" sql: "select * from my_table" dsn: "mysql_user:mysql_password@tcp(localhost:3306)/mysql_db" ``` diff --git a/docs/docs/reference/connectors/postgres.md b/docs/docs/reference/connectors/postgres.md index ab340eff563..b2d89988724 100644 --- a/docs/docs/reference/connectors/postgres.md +++ b/docs/docs/reference/connectors/postgres.md @@ -36,7 +36,8 @@ Alternatively, you can include the connection string directly in the source YAML An example of a source using this approach: ```yaml -type: "postgres" +type: "source" +connector: "postgres" sql: "select * from my_table" database_url: "postgresql://postgres:postgres@localhost:5432/postgres" ``` diff --git a/docs/docs/reference/connectors/salesforce.md b/docs/docs/reference/connectors/salesforce.md index 94a4ecf3793..96f7bad10a0 100644 --- a/docs/docs/reference/connectors/salesforce.md +++ b/docs/docs/reference/connectors/salesforce.md @@ -22,7 +22,8 @@ rill start --var connector.salesforce.username="user@example.com" --var connecto Alternatively, you can also include the credentials directly in the underlying source YAML by adding the `username` and `password` parameters. For example, your source YAML may contain the following properties (also can be configured through the UI during source creation): ```yaml -type: "salesforce" +type: "source" +connector: "salesforce" endpoint: "login.salesforce.com" username: "user@example.com" password: "MyPasswordMyToken" diff --git a/docs/docs/reference/connectors/sqlite.md b/docs/docs/reference/connectors/sqlite.md index 4f28b440d89..59fbb94d447 100644 --- a/docs/docs/reference/connectors/sqlite.md +++ b/docs/docs/reference/connectors/sqlite.md @@ -22,10 +22,9 @@ In many cases, since SQLite is used as an in-process database, credentials are n On the other hand, if you are creating the source YAML file directly, the definition should look something like: ```yaml - -type: "duckdb" +type: "source" +connector: "duckdb" sql: "SELECT * FROM sqlite_scan('', '');" - ``` :::tip