commit
3e8f2ab349
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
title: Flux SQL package
|
||||
list_title: SQL package
|
||||
description: >
|
||||
The Flux SQL package provides tools for working with data in SQL databases such as MySQL and PostgreSQL.
|
||||
Import the `sql` package.
|
||||
menu:
|
||||
v2_0_ref:
|
||||
name: SQL
|
||||
parent: Flux packages and functions
|
||||
weight: 202
|
||||
v2.0/tags: [functions, sql, package, mysql, postgres]
|
||||
---
|
||||
|
||||
SQL Flux functions provide tools for working with data in SQL databases such as MySQL and PostgreSQL.
|
||||
Import the `sql` package:
|
||||
|
||||
```js
|
||||
import "sql"
|
||||
```
|
||||
|
||||
{{< children type="functions" show="pages" >}}
|
|
@ -0,0 +1,79 @@
|
|||
---
|
||||
title: sql.from() function
|
||||
description: The `sql.from()` function retrieves data from a SQL data source.
|
||||
menu:
|
||||
v2_0_ref:
|
||||
name: sql.from
|
||||
parent: SQL
|
||||
weight: 202
|
||||
---
|
||||
|
||||
The `sql.from()` function retrieves data from a SQL data source.
|
||||
|
||||
_**Function type:** Input_
|
||||
|
||||
```js
|
||||
import "sql"
|
||||
|
||||
sql.from(
|
||||
driverName: "postgres",
|
||||
dataSourceName: "postgresql://user:password@localhost",
|
||||
query:"SELECT * FROM TestTable"
|
||||
)
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
### driverName
|
||||
The driver used to connect to the SQL database.
|
||||
|
||||
_**Data type:** String_
|
||||
|
||||
The following drivers are available:
|
||||
|
||||
- mysql
|
||||
- postgres
|
||||
|
||||
### dataSourceName
|
||||
The connection string used to connect to the SQL database.
|
||||
The string's form and structure depend on the [driver](#drivername) used.
|
||||
|
||||
_**Data type:** String_
|
||||
|
||||
##### Driver dataSourceName examples
|
||||
```sh
|
||||
# Postgres Driver:
|
||||
postgres://pqgotest:password@localhost/pqgotest?sslmode=verify-full
|
||||
|
||||
# MySQL Driver:
|
||||
username:password@tcp(localhost:3306)/dbname?param=value
|
||||
```
|
||||
|
||||
### query
|
||||
The query to run against the SQL database.
|
||||
|
||||
_**Data type:** String_
|
||||
|
||||
## Examples
|
||||
|
||||
### Query a MySQL database
|
||||
```js
|
||||
import "sql"
|
||||
|
||||
sql.from(
|
||||
driverName: "mysql",
|
||||
dataSourceName: "user:password@tcp(localhost:3306)/db",
|
||||
query:"SELECT * FROM ExampleTable"
|
||||
)
|
||||
```
|
||||
|
||||
### Query a Postgres database
|
||||
```js
|
||||
import "sql"
|
||||
|
||||
sql.from(
|
||||
driverName: "postgres",
|
||||
dataSourceName: "postgresql://user:password@localhost",
|
||||
query:"SELECT * FROM TestTable"
|
||||
)
|
||||
```
|
|
@ -0,0 +1,80 @@
|
|||
---
|
||||
title: sql.to() function
|
||||
description: The `sql.to()` function writes data to a SQL database.
|
||||
menu:
|
||||
v2_0_ref:
|
||||
name: sql.to
|
||||
parent: SQL
|
||||
weight: 202
|
||||
draft: true
|
||||
---
|
||||
|
||||
The `sql.to()` function writes data to a SQL database.
|
||||
|
||||
_**Function type:** Output_
|
||||
|
||||
```js
|
||||
import "sql"
|
||||
|
||||
sql.to(
|
||||
driverName: "mysql",
|
||||
dataSourceName: "username:password@tcp(localhost:3306)/dbname?param=value",
|
||||
table: "ExampleTable"
|
||||
)
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
### driverName
|
||||
The driver used to connect to the SQL database.
|
||||
|
||||
_**Data type:** String_
|
||||
|
||||
The following drivers are available:
|
||||
|
||||
- mysql
|
||||
- postgres
|
||||
|
||||
### dataSourceName
|
||||
The connection string used to connect to the SQL database.
|
||||
The string's form and structure depend on the [driver](#drivername) used.
|
||||
|
||||
_**Data type:** String_
|
||||
|
||||
##### Driver dataSourceName examples
|
||||
```sh
|
||||
# Postgres Driver
|
||||
postgres://pqgotest:password@localhost/pqgotest?sslmode=verify-full
|
||||
|
||||
# MySQL Driver
|
||||
username:password@tcp(localhost:3306)/dbname?param=value
|
||||
```
|
||||
|
||||
### table
|
||||
The destination table.
|
||||
|
||||
_**Data type:** String_
|
||||
|
||||
## Examples
|
||||
|
||||
### Write data to a MySQL database
|
||||
```js
|
||||
import "sql"
|
||||
|
||||
sql.to(
|
||||
driverName: "mysql",
|
||||
dataSourceName: "user:password@tcp(localhost:3306)/db",
|
||||
table: "ExampleTable"
|
||||
)
|
||||
```
|
||||
|
||||
### Write data to a Postgres database
|
||||
```js
|
||||
import "sql"
|
||||
|
||||
sql.to(
|
||||
driverName: "postgres",
|
||||
dataSourceName: "postgresql://user:password@localhost",
|
||||
table: "ExampleTable"
|
||||
)
|
||||
```
|
Loading…
Reference in New Issue