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

Document ingest data from MySQL table #158

Merged
merged 1 commit into from
Dec 25, 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
1 change: 1 addition & 0 deletions changelog/product-lifecycle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Below is a list of all features in the public preview phase:

| Feature name | Start version |
| :-- | :-- |
| [Ingest data from MySQL table](/integrations/sources/mysql-table)| 2.2 |
| [EXPLAIN FORMAT JSON](/sql/commands/sql-explain#explain-options)| 2.2 |
| [Ingest data from Postgres table](/integrations/sources/postgresql-table) | 2.1 |
| [Ingest data from webhook](/integrations/sources/webhook) | 2.1 |
Expand Down
6 changes: 3 additions & 3 deletions ingestion/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,11 @@ The statement will create a streaming job that continuously ingests data from th
4. **Stronger consistency guarantee**: When using a table with connectors, all downstream jobs will be guaranteed to have a consistent view of the data persisted in the table; while for source, different jobs may see inconsistent results due to different ingestion speed or data retention in the external system.
5. **Greater flexibility**: Like regular tables, you can use DML statements like [INSERT](/sql/commands/sql-insert), [UPDATE](/sql/commands/sql-update) and [DELETE](/sql/commands/sql-delete) to insert or modify data in tables with connectors, and use [CREATE SINK INTO TABLE](/sql/commands/sql-create-sink-into) to merge other data streams into the table.

### PostgreSQL table
### Table-valued function

RisingWave supports using the table-valued function `postgres_query` to directly query PostgreSQL databases. This function connects to a specified PostgreSQL instance, executes the provided SQL query, and returns the results as a table in RisingWave.
RisingWave supports using the table-valued function (TVF) `postgres_query` or `mysql_query` to directly query PostgreSQL or MySQL databases. This function connects to a specified instance, executes the provided SQL query, and returns the results as a table in RisingWave.

To use it, specify connection details (such as hostname, port, username, password, database name) and the desired SQL query. This makes it easier to integrate PostgreSQL data directly into RisingWave workflows without needing additional data transfer steps. For more information, see [Ingest data from Postgres tables](/integrations/sources/postgresql-table).
To use it, specify connection details (such as hostname, port, username, password, database name) and the desired SQL query. This makes it easier to integrate databases directly into RisingWave workflows without needing additional data transfer steps. For more information, see [Ingest data from Postgres tables](/integrations/sources/postgresql-table) and [Ingest data from MySQL tables](/integrations/sources/mysql-table).

## DML on tables

Expand Down
102 changes: 102 additions & 0 deletions integrations/sources/mysql-table.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
title: "Ingest data from MySQL table"
description: "Describes how to ingest data from MySQL table to RisingWave using table-valued function."
sidebarTitle: MySQL table
---

RisingWave allows you to query MySQL tables directly with the `mysql_query` table-valued function (TVF). It offers a simpler alternative to Change Data Capture (CDC) when working with MySQL data in RisingWave.

Unlike CDC, which continuously syncs data changes, this function lets you fetch data directly from MySQL when needed. Therefore, this approach is ideal for static or infrequently updated data, as it's more resource-efficient than maintaining a constant CDC connection.

<Note>
**PUBLIC PREVIEW**

This feature is currently in public preview, meaning it is nearing the final product but may not yet be fully stable. If you encounter any issues or have feedback, please reach out to us via our [Slack channel](https://www.risingwave.com/slack). Your input is valuable in helping us improve this feature. For more details, see our [Public Preview Feature List](/changelog/product-lifecycle#features-in-the-public-preview-stage).
</Note>

<Note>
Added in version 2.2.
</Note>

## Syntax

Define `mysql_query` as follows:

```sql
mysql_query(
hostname varchar, -- Database hostname
port varchar, -- Database port
username varchar, -- Authentication username
password varchar, -- Authentication password
database_name varchar, -- Target database name
query varchar -- SQL query to execute
)
```

## Data type mapping

The following table shows how MySQL data types are mapped to RisingWave data types:

| MySQL Type | RisingWave Type |
|:-----------|:----------------|
| `bit(1)` | `boolean` |
| `bit(>1)` | `bytea` |
| `bool`/`boolean` | `smallint` |
| `tinyint` | `smallint` |
| `smallint` | `smallint` |
| `mediumint` | `int` |
| `int` | `int` |
| `bigint` | `bigint` |
| `float` | `float32` |
| `double` | `float64` |
| `decimal` | `decimal` |
| `numeric` | `decimal` |
| `year` | `int` |
| `date` | `date` |
| `time` | `time` |
| `datetime` | `timestamp` |
| `timestamp` | `timestamptz` |
| `varchar` | `varchar` |
| `char` | `varchar` |
| `json` | `jsonb` |
| `blob` | `bytea` |
| `tinyblob` | `bytea` |
| `mediumblob` | `bytea` |
| `longblob` | `bytea` |
| `array` | *unsupported* |
| `enum` | *unsupported* |
| `set` | *unsupported* |
| `geometry` | *unsupported* |
| `null` | *unsupported* |

## Example

1. In your MySQL database, create a table and populate it with sample data of various data types.

```sql
CREATE TABLE test (
id bigint primary key, v0 bit, v1 bool, v2 tinyint(1),
v3 tinyint(2), v4 smallint, v5 mediumint, v6 integer,
v7 bigint, v8 float, v9 double, v10 numeric(4, 2),
v11 decimal(4, 2), v12 char(255), v13 varchar(255),
v14 bit(10), v15 tinyblob, v16 blob, v17 mediumblob,
v18 longblob, v19 date, v20 time, v21 timestamp,
v22 json
);

INSERT INTO test SELECT
1 as id, true as v0, true as v1, 2 as v2, 3 as v3, 4 as v4, 5 as v5,
6 as v6, 7 as v7, 1.08 as v8, 1.09 as v9, 1.10 as v10, 1.11 as v11,
'char' as v12, 'varchar' as v13, b'1010' as v14, x'16' as v15, x'17' as v16,
x'18' as v17, x'19' as v18, '2021-01-01' as v19, '12:34:56' as v20,
'2021-01-01 12:34:56' as v21, JSON_OBJECT('key1', 1, 'key2', 'abc');
```

2. In RisingWave, use `postgres_query` function to perform the query.

```sql
SELECT *
FROM mysql_query('$MYSQL_HOST', '$MYSQL_TCP_PORT', '$RISEDEV_MYSQL_USER', '$MYSQL_PWD', 'tvf', 'select * from test;');
----RESULT
1 t 1 2 3 4 5 6 7 1.08 1.09 1.10 1.11 char varchar \x000a \x16 \x17 \x18 \x19 2021-01-01 12:34:56 2021-01-01 12:34:56+00:00 {"key1": 1, "key2": "abc"}
```
6 changes: 5 additions & 1 deletion integrations/sources/postgresql-table.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@ sidebarTitle: PostgreSQL table

RisingWave allows you to query PostgreSQL tables directly with the `postgres_query` table-valued function (TVF). It offers a simpler alternative to Change Data Capture (CDC) when working with PostgreSQL data in RisingWave.

Unlike CDC, which continuously syncs data changes, this function lets you fetch data directly from PostgreSQL when needed. Therefore, this approach is ideal static or infrequently updated data, as it's more resource-efficient than maintaining a constant CDC connection.
Unlike CDC, which continuously syncs data changes, this function lets you fetch data directly from PostgreSQL when needed. Therefore, this approach is ideal for static or infrequently updated data, as it's more resource-efficient than maintaining a constant CDC connection.

<Note>
**PUBLIC PREVIEW**

This feature is currently in public preview, meaning it is nearing the final product but may not yet be fully stable. If you encounter any issues or have feedback, please reach out to us via our [Slack channel](https://www.risingwave.com/slack). Your input is valuable in helping us improve this feature. For more details, see our [Public Preview Feature List](/changelog/product-lifecycle#features-in-the-public-preview-stage).
</Note>

<Note>
Added in version 2.1.
</Note>

## Syntax

Define `postgres_query` as follows:
Expand Down
Loading