Skip to content

Commit

Permalink
Docs: update example Source YAML (#4842)
Browse files Browse the repository at this point in the history
  • Loading branch information
ericpgreen2 authored May 6, 2024
1 parent 3a0b8c2 commit e95cf61
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 9 deletions.
5 changes: 2 additions & 3 deletions docs/docs/reference/connectors/motherduck.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <duckdb_table>"
db: "<path_to_duckdb_db_file>"

```
:::tip If deploying to Rill Cloud
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/reference/connectors/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/reference/connectors/postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/reference/connectors/salesforce.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ rill start --var connector.salesforce.username="[email protected]" --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: "[email protected]"
password: "MyPasswordMyToken"
Expand Down
5 changes: 2 additions & 3 deletions docs/docs/reference/connectors/sqlite.md
Original file line number Diff line number Diff line change
Expand Up @@ -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('<path_to_sqlite_db>', '<table_name>');"

```
:::tip
Expand Down

0 comments on commit e95cf61

Please sign in to comment.