Apache ShardingSphere

https://shardingsphere.apache.org/document/current/en/
Admin
Apache ShardingSphere is an ecosystem to transform any database into a distributed database system...
Tokens:196,954
Snippets:2,419
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### Start CDC Client Java Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/cdc/usage

This example demonstrates how to initialize and start the CDC client. It includes constructing the client configuration, connecting to the server, logging in, and initiating data streaming. Ensure the subscribed database and table exist in ShardingSphere-Proxy.

```java
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.apache.shardingsphere.data.pipeline.cdc.client.CDCClient;
import org.apache.shardingsphere.data.pipeline.cdc.client.config.CDCClientConfiguration;
import org.apache.shardingsphere.data.pipeline.cdc.client.handler.RetryStreamingExceptionHandler;
import org.apache.shardingsphere.data.pipeline.cdc.client.parameter.CDCLoginParameter;
import org.apache.shardingsphere.data.pipeline.cdc.client.parameter.StartStreamingParameter;
import org.apache.shardingsphere.data.pipeline.cdc.protocol.request.StreamDataRequestBody.SchemaTable;

import java.util.Collections;

@Slf4j
public final class Bootstrap {

    @SneakyThrows(InterruptedException.class)
    public static void main(final String[] args) {
        String address = "127.0.0.1";
        // Construct CDCClient, pass in CDCClientConfiguration, CDCClientConfiguration contains the address and port of the CDC Server, as well as the timeout time
        try (CDCClient cdcClient = new CDCClient(new CDCClientConfiguration(address, 33071, 10000))) {
            // First call connect to the CDC Server, you need to pass in 1. Data consumption processing logic 2. Exception handling logic during consumption 3. Server error exception handling logic
            cdcClient.connect(records -> log.info("records: {}", records), new RetryStreamingExceptionHandler(cdcClient, 5, 5000),
                    (ctx, result) -> log.error("Server error: {}", result.getErrorMessage()));
            cdcClient.login(new CDCLoginParameter("root", "root"));
            // Start CDC data synchronization, the returned streamingId is the unique identifier of this CDC task, the basis for the CDC Server to generate a unique identifier is the name of the subscribed database + the subscribed table + whether it is full synchronization
            String streamingId = cdcClient.startStreaming(new StartStreamingParameter("sharding_db", Collections.singleton(SchemaTable.newBuilder().setTable("t_order").build()), true));
            log.info("Streaming id={}", streamingId);
            // Prevent the main thread from exiting
            cdcClient.await();
        }
    }
}

```

--------------------------------

### Show Encrypt Algorithm Plugins Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/plugin/show-encrypt-algorithm-plugins

Example of querying and the expected output format for available encrypt algorithm plugins.

```sql
SHOW ENCRYPT ALGORITHM PLUGINS;
+------+--------------+-------------+
| type | type_aliases | description |
+------+--------------+-------------+
| AES  |              |             |
| MD5  |              |             |
+------+--------------+-------------+
2 rows in set (0.06 sec)
```

--------------------------------

### Install DBeaver Community

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/optional-plugins/clickhouse

Instructions for installing DBeaver Community on Ubuntu 24.04 using Snapcraft for database management.

```bash
sudo apt update && sudo apt upgrade -y
sudo snap install dbeaver-ce --classic
snap run dbeaver-ce

```

--------------------------------

### Start ShardingSphere-Proxy

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/cdc/build

Execute this command to start the ShardingSphere-Proxy service. Ensure you are in the ShardingSphere-Proxy directory.

```bash
sh bin/start.sh
```

--------------------------------

### Start ClickHouse with Docker Compose

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/optional-plugins/clickhouse

Define a Docker Compose file to easily start a ClickHouse server instance. This example uses a specific image version and exposes the default port.

```yaml
services:
  clickhouse-server:
    image: clickhouse/clickhouse-server:25.12.1.649
    environment:
      CLICKHOUSE_SKIP_USER_SETUP: "1"
    ports:
      - "8123:8123"

```

--------------------------------

### Start ShardingSphere-Proxy with Custom Port and Configuration

Source: https://shardingsphere.apache.org/document/current/en/quick-start/shardingsphere-proxy-quick-start

Customize the proxy port and configuration directory when starting ShardingSphere-Proxy.

```bash
sh %SHARDINGSPHERE_PROXY_HOME%/bin/start.sh ${proxy_port} ${proxy_conf_directory}

```

--------------------------------

### Query Migration Check Algorithm Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-check-algorithm

This example demonstrates how to query migration check algorithms and shows the expected output format, including algorithm type, supported databases, and descriptions.

```sql
mysql> SHOW MIGRATION CHECK ALGORITHMS;
+-------------+--------------------------------------------------------------+----------------------------+
| type        | supported_database_types                                     | description                |
+-------------+--------------------------------------------------------------+----------------------------+
| CRC32_MATCH | MySQL                                                        | Match CRC32 of records.    |
| DATA_MATCH  | SQL92,MySQL,MariaDB,PostgreSQL,openGauss,Oracle,SQLServer,H2 | Match raw data of records. |
+-------------+--------------------------------------------------------------+----------------------------+
2 rows in set (0.03 sec)
```

--------------------------------

### Example Output of SHOW MIGRATION RULE

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/show-migration-rule

This example demonstrates the typical output format when querying migration rules, showing details for read, write, and stream channel configurations.

```text
mysql> SHOW MIGRATION RULE;
+--------------------------------------------------------------+--------------------------------------+-------------------------------------------------------+
| read                                                         | write                                | stream_channel                                        |
+--------------------------------------------------------------+--------------------------------------+-------------------------------------------------------+
| {"workerThread":20,"batchSize":1000,"shardingSize":10000000} | {"workerThread":20,"batchSize":1000} | {"type":"MEMORY","props":{"block-queue-size":"2000"}} |
+--------------------------------------------------------------+--------------------------------------+-------------------------------------------------------+
1 row in set (0.01 sec)
```

--------------------------------

### Start ShardingSphere-Proxy Script

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/migration/build

Execute this script to start the ShardingSphere-Proxy service.

```bash
sh bin/start.sh

```

--------------------------------

### Install ShardingSphere-Proxy from Source using Helm

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/helm

Install ShardingSphere-Proxy from its source code repository using Helm. This involves cloning the repository, building dependencies, and then installing the charts.

```bash
git clone https://github.com/apache/shardingsphere-on-cloud.git
cd charts/shardingsphere-proxy/charts/governance
helm dependency build 
cd ../..
helm dependency build 
cd ..
helm install shardingsphere-proxy shardingsphere-proxy
```

--------------------------------

### Full Instance Route Example

Source: https://shardingsphere.apache.org/document/current/en/reference/sharding/route

Illustrates a DCL operation for creating a user, which is executed once on each real database instance.

```sql
CREATE USER customer@127.0.0.1 identified BY '123';
```

--------------------------------

### Start Migration Process

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration

Use this command to start a data migration job. The `migrationJobId` must be obtained from the `SHOW MIGRATION LIST` command.

```sql
START MIGRATION 'j010180026753ef0e25d3932d94d1673ba551';
```

--------------------------------

### GraalVM Native Image Maven Plugin Configuration Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/graalvm-native-image

Example configuration for the GraalVM Native Image Maven plugin, demonstrating how to set build arguments. This configuration is part of the project's build setup.

```xml
<project>
    <build>
        <plugins>
            <plugin>
                <groupId>org.graalvm.buildtools</groupId>
                <artifactId>native-maven-plugin</artifactId>
                <version>0.11.5</version>
                <extensions>true</extensions>
                <configuration>

```

--------------------------------

### Full Database Route Example

Source: https://shardingsphere.apache.org/document/current/en/reference/sharding/route

Shows a SET command for database settings that is executed on all real databases matching the logical database name.

```sql
SET autocommit=0;
```

--------------------------------

### Example SQL for Parsing

Source: https://shardingsphere.apache.org/document/current/en/reference/sharding/parse

This is an example of a SQL query that will be parsed by the ShardingSphere engine.

```sql
SELECT id, name FROM t_user WHERE status = 'ACTIVE' AND age > 18

```

--------------------------------

### SysBench Test Output Header

Source: https://shardingsphere.apache.org/document/current/en/test-manual/performance-test/sysbench-proxy-norules-test

Example output header from SysBench indicating the test version and initial configuration parameters. This helps in verifying the test setup.

```text
sysbench 1.0.20 (using bundled LuaJIT 2.1.0-beta2)
Running the test with following options:
Number of threads: 200
Report intermediate results every 10 second(s)
Initializing random number generator from current time
Initializing worker threads...
Threads started!

```

--------------------------------

### Example Query and Result

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/count-single-table

Demonstrates an example of executing the COUNT SINGLE TABLE command and the expected output format, showing the database name and the count of single tables.

```sql
mysql> COUNT SINGLE TABLE;
+----------+--------+
| database | count  |
+----------+--------+
| ds       | 2      |
+----------+--------+
1 row in set (0.02 sec)
```

--------------------------------

### Formatted SQL Output Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/rul/format-sql

This example demonstrates the expected output when using the FORMAT SQL syntax with a sample SELECT statement. The result is a neatly formatted SQL query.

```sql
mysql> FORMAT SELECT * FROM t_order;
+-------------------------+
| formatted_result        |
+-------------------------+
| SELECT *
FROM t_order; |
+-------------------------+
1 row in set (0.00 sec)
```

--------------------------------

### Start ShardingSphere-Proxy with Default Configuration

Source: https://shardingsphere.apache.org/document/current/en/quick-start/shardingsphere-proxy-quick-start

Use this command to start ShardingSphere-Proxy with default port 3307 and configuration directory.

```bash
sh %SHARDINGSPHERE_PROXY_HOME%/bin/start.sh

```

--------------------------------

### Create Target Table (MySQL Example)

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/migration/usage

If migrating to a heterogeneous database like MySQL, execute the table-creation statements in the proxy.

```sql
CREATE TABLE t_order (order_id INT NOT NULL, user_id INT NOT NULL, status VARCHAR(45) NULL, PRIMARY KEY (order_id));

```

--------------------------------

### Install ShardingSphere-Proxy using Helm

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/helm

Install ShardingSphere-Proxy charts using the Helm package manager. This command installs with default configurations.

```bash
helm install shardingsphere-proxy shardingsphere/shardingsphere-proxy
```

--------------------------------

### Start ShardingSphere-Proxy with Agent

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/observability

After configuring the agent, start ShardingSphere-Proxy using the provided script. The agent will be activated, and plugin information will be visible in the proxy logs. Metrics and tracing data can then be accessed via the configured monitoring addresses.

```bash
tar -zxvf apache-shardingsphere-${latest.release.version}-shardingsphere-proxy-bin.tar.gz
cd apache-shardingsphere-${latest.release.version}-shardingsphere-proxy-bin
./bin/start.sh -g

```

--------------------------------

### Start ShardingSphere-Proxy Container with Volume Mounts

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/docker

Start the ShardingSphere-Proxy container by mounting your local configuration and external library directories into the container. This ensures your custom configurations are used.

```bash
docker run -d \
    -v /host/path/to/conf:/opt/shardingsphere-proxy/conf \
    -v /host/path/to/ext-lib:/opt/shardingsphere-proxy/ext-lib \
    -e PORT=3308 -p13308:3308 apache/shardingsphere-proxy:latest
```

--------------------------------

### Shadow Rule Configuration Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/java-api/rules/shadow

Demonstrates how to configure Shadow DB rules programmatically. This includes setting up data sources, tables, and shadow algorithms.

```java
public final class ShadowConfiguration {

    @Override
    public DataSource getDataSource() throws SQLException {
        Map<String, DataSource> dataSourceMap = createDataSourceMap();
        return ShardingSphereDataSourceFactory.createDataSource(dataSourceMap, createRuleConfigurations(), createShardingSphereProps());
    }
    
    private Map<String, DataSource> createDataSourceMap() {
        Map<String, DataSource> result = new LinkedHashMap<>();
        result.put("ds", DataSourceUtil.createDataSource("demo_ds"));
        result.put("ds_shadow", DataSourceUtil.createDataSource("shadow_demo_ds"));
        return result;
    }
    
    private Collection<RuleConfiguration> createRuleConfigurations() {
        Collection<RuleConfiguration> result = new LinkedList<>();
        ShadowRuleConfiguration shadowRule = new ShadowRuleConfiguration();
        shadowRule.setDataSources(createShadowDataSources());
        shadowRule.setTables(createShadowTables());
        shadowRule.setShadowAlgorithms(createShadowAlgorithmConfigurations());
        result.add(shadowRule);
        return result;
    }
    
    private Map<String, ShadowDataSourceConfiguration> createShadowDataSources() {
        Map<String, ShadowDataSourceConfiguration> result = new LinkedHashMap<>();
        result.put("shadow-data-source", new ShadowDataSourceConfiguration("ds", "ds_shadow"));
        return result;
    }
    
    private Map<String, ShadowTableConfiguration> createShadowTables() {
        Map<String, ShadowTableConfiguration> result = new LinkedHashMap<>();
        result.put("t_user", new ShadowTableConfiguration(Collections.singletonList("shadow-data-source"), createShadowAlgorithmNames()));
        return result;
    }
    
    private Collection<String> createShadowAlgorithmNames() {
        Collection<String> result = new LinkedList<>();
        result.add("user-id-insert-match-algorithm");
        result.add("simple-hint-algorithm");
        return result;
    }
    
    private Map<String, AlgorithmConfiguration> createShadowAlgorithmConfigurations() {
        Map<String, AlgorithmConfiguration> result = new LinkedHashMap<>();
        Properties userIdInsertProps = new Properties();
        userIdInsertProps.setProperty("operation", "insert");
        userIdInsertProps.setProperty("column", "user_type");
        userIdInsertProps.setProperty("value", "1");
        result.put("user-id-insert-match-algorithm", new AlgorithmConfiguration("VALUE_MATCH", userIdInsertProps));
        return result;
    }
}
```

--------------------------------

### init.sql Content for HiveServer2

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/optional-plugins/hiveserver2

Example content for the `init.sql` file, containing HiveServer2 specific `set` commands to configure the environment dynamically.

```sql
-- noinspection SqlNoDataSourceInspectionForFile
set metastore.compactor.initiator.on=true;
set metastore.compactor.cleaner.on=true;
set metastore.compactor.worker.threads=1;

set hive.support.concurrency=true;
set hive.exec.dynamic.partition.mode=nonstrict;
set hive.txn.manager=org.apache.hadoop.hive.ql.lockmgr.DbTxnManager;

```

--------------------------------

### Hint Configuration Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/special-api/sharding/hint

This configuration demonstrates how to set up hint-based sharding strategies for both database and table routing. It specifies custom sharding algorithms and their properties.

```yaml
rules:
  - !SHARDING
    tables:
      t_order:
        actualDataNodes: demo_ds_${0..1}.t_order_${0..1}
        databaseStrategy:
          hint:
            shardingColumn: order_id
            shardingAlgorithmName: hint_class_based
        tableStrategy:
          hint:
            shardingColumn: order_id
            shardingAlgorithmName: hint_inline
    shardingAlgorithms:
      hint_class_based:
        type: CLASS_BASED
        props:
          strategy: STANDARD
          algorithmClassName: xxx.xxx.xxx.HintXXXAlgorithm
      hint_inline:
        type: HINT_INLINE
        props:
          algorithm-expression: t_order_$->{value % 4}
    defaultTableStrategy:
      none:
    defaultKeyGenerateStrategy:
      type: SNOWFLAKE
      column: order_id

props:
  sql-show: true


```

--------------------------------

### Start ShardingSphere-Proxy Script

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/bin

Use this script to start ShardingSphere-Proxy. You can optionally specify the listening port and the configuration directory.

```bash
bin/start.sh [port] [/path/to/conf]
```

--------------------------------

### Example Output of SHOW COMPUTE NODES

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/show-compute-node-info

This example demonstrates the typical output format when querying compute nodes, showing details like instance ID, type, host, port, status, mode, worker ID, labels, and version.

```text
mysql> SHOW COMPUTE NODES;
+--------------------------------------+---------------+------------+------+--------+------------+-----------+--------+----------+
| instance_id                          | instance_type | host       | port | status | mode_type  | worker_id | labels | version  |
+--------------------------------------+---------------+------------+------+--------+------------+-----------+--------+----------+
| 3e84d33e-cb97-42f2-b6ce-f78fea0ded89 | PROXY         | 127.0.0.1  | 3307 | OK     | Cluster    | -1        |        | 5.4.2    |
+--------------------------------------+---------------+------------+------+--------+------------+-----------+--------+----------+
1 row in set (0.01 sec)

```

--------------------------------

### ShardingSphere JDBC Integration Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/special-api/transaction/seata

Demonstrates how to initialize a ShardingSphere data source using a classpath configuration file and perform transactional operations.

```java
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import java.sql.Connection;
import java.sql.SQLException;
@SuppressWarnings({"SqlNoDataSourceInspection", "AssertWithSideEffects"})
public class ExampleTest {
    void test() throws SQLException {
        HikariConfig config = new HikariConfig();
        config.setJdbcUrl("jdbc:shardingsphere:classpath:demo.yaml");
        config.setDriverClassName("org.apache.shardingsphere.driver.ShardingSphereDriver");
        try (HikariDataSource dataSource = new HikariDataSource(config)) {
            try (Connection conn = dataSource.getConnection()) {
                try {
                    conn.setAutoCommit(false);
                    conn.createStatement().executeUpdate("INSERT INTO t_order (user_id, order_type, address_id, status) VALUES (2024, 1, 2024, 'INSERT_TEST')");
                    conn.createStatement().executeUpdate("INSERT INTO t_order_does_not_exist (test_id_does_not_exist) VALUES (2024)");
                    conn.commit();
                } catch (final SQLException ignored) {
                    conn.rollback();
                } finally {
                    conn.setAutoCommit(true);
                }
            }
            try (Connection conn = dataSource.getConnection()) {
                assert !conn.createStatement().executeQuery("SELECT * FROM t_order_item WHERE user_id = 2024").next();
            }
        }
    }
}
```

--------------------------------

### Install DBeaver Community

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/optional-plugins/presto

Quickly install DBeaver Community on Ubuntu 24.04 using Snapcraft for connecting to Presto. This command updates packages, installs DBeaver, and launches it.

```bash
sudo apt update && sudo apt upgrade -y
sudo snap install dbeaver-ce --classic
snap run dbeaver-ce
```

--------------------------------

### SQL Query Example 1

Source: https://shardingsphere.apache.org/document/current/en/test-manual/performance-test/benchmarksql-proxy-sharding-test

Example SQL query joining `bmsql_customer` and `bmsql_warehouse` tables. This query can benefit from binding table configuration if `w_id` is used as the sharding key.

```sql
SELECT c_discount, c_last, c_credit, w_tax     
FROM bmsql_customer     
    JOIN bmsql_warehouse ON (w_id = c_w_id)     
WHERE c_w_id = ? AND c_d_id = ? AND c_id = ?
```

--------------------------------

### Start Migration Command

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration

The `START MIGRATION` command is used to initiate a data migration job. You need to provide the `migrationJobId` which can be obtained by querying `SHOW MIGRATION LIST`.

```APIDOC
## START MIGRATION

### Description

The `START MIGRATION` syntax is used to start migration process.

### Syntax

```
StartMigration ::=
  'START' 'MIGRATION'  migrationJobId 

migrationJobId ::=
  string
```

### Supplement

* `migrationJobId` needs to be obtained through SHOW MIGRATION LIST syntax query

### Example

```sql
START MIGRATION 'j010180026753ef0e25d3932d94d1673ba551';
```

### Reserved word

`START` , `MIGRATION`

### Related links

* Reserved word
* SHOW MIGRATION LIST
```

--------------------------------

### Install Native Toolchain on Ubuntu

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/graalvm-native-image/development

Installs the necessary build tools for compiling GraalVM Native Image on Ubuntu. This includes build-essential and zlib1g-dev.

```bash
sudo apt-get install build-essential zlib1g-dev -y
```

--------------------------------

### Install socat and Configure Docker Host for M-series Macs

Source: https://shardingsphere.apache.org/document/current/en/test-manual/integration-test

On Mac M-series chips, install `socat` and configure `DOCKER_HOST` before packaging the Proxy image.

```bash
# Install socat
brew install socat
socat TCP-LISTEN:2375,reuseaddr,fork UNIX-CLIENT:/var/run/docker.sock

# Execute in the terminal where the image is created
export DOCKER_HOST=tcp://127.0.0.1:2375
```

--------------------------------

### Unicast Route Example

Source: https://shardingsphere.apache.org/document/current/en/reference/sharding/route

Demonstrates a DESCRIBE command to obtain the information of a real table, executed only once on any real table.

```sql
DESCRIBE t_order;
```

--------------------------------

### Example Output of SHOW UNLOADED SINGLE TABLES

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/rql/rule-query/single-table/show-unloaded-single-tables

This example demonstrates the typical output format when querying for unloaded single tables. It lists the table name and its associated storage unit.

```text
mysql> SHOW UNLOADED SINGLE TABLES;
+------------+-------------------+
| table_name | storage_unit_name |
+------------+-------------------+  
| t_single   | ds_1              |
+------------+-------------------+
1 row in set (0.01 sec)
```

--------------------------------

### Start Firebird with Docker Compose

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/optional-plugins/firebird

Use this Docker Compose configuration to start a Firebird instance with specified user credentials and database settings.

```yaml
services:
  firebird:
    image: firebirdsql/firebird:5.0.3
    environment:
      FIREBIRD_ROOT_PASSWORD: masterkey
      FIREBIRD_USER: alice
      FIREBIRD_PASSWORD: masterkey
      FIREBIRD_DATABASE: mirror.fdb
      FIREBIRD_DATABASE_DEFAULT_CHARSET: UTF8
    ports:
      - "3050:3050"

```

--------------------------------

### Sample SQL Parser YAML Configuration

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-parser

Provides a concrete example of setting initial and maximum capacities for SQL statement and parse tree local caches.

```yaml
sqlParser:
  sqlStatementCache:
    initialCapacity: 2000
    maximumSize: 65535
  parseTreeCache:
    initialCapacity: 128
    maximumSize: 1024

```

--------------------------------

### Subquery Examples

Source: https://shardingsphere.apache.org/document/current/en/features/sharding/limitation

Demonstrates supported subquery patterns within the Federation execution engine. These examples show how subqueries can be used with or without sharding keys, provided they are consistent.

```sql
SELECT * FROM (SELECT * FROM t_order) o;
```

```sql
SELECT * FROM (SELECT * FROM t_order) o WHERE o.order_id = 1;
```

```sql
SELECT * FROM (SELECT * FROM t_order WHERE order_id = 1) o;
```

```sql
SELECT * FROM (SELECT * FROM t_order WHERE order_id = 1) o WHERE o.order_id = 2;
```

--------------------------------

### Prepare Target Databases

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/migration/usage

Create the target databases in MySQL that will receive the migrated data. Ensure these databases are empty before starting the migration.

```sql
DROP DATABASE IF EXISTS migration_ds_10;
CREATE DATABASE migration_ds_10 DEFAULT CHARSET utf8;

DROP DATABASE IF EXISTS migration_ds_11;
CREATE DATABASE migration_ds_11 DEFAULT CHARSET utf8;

DROP DATABASE IF EXISTS migration_ds_12;
CREATE DATABASE migration_ds_12 DEFAULT CHARSET utf8;


```

--------------------------------

### Alter Shadow Rule Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/rdl/rule-definition/shadow/alter-shadow-rule

This example demonstrates how to alter an existing shadow rule, specifying source and shadow storage units, and configuring shadow algorithms for different tables. It uses SQL_HINT for one table and VALUE_MATCH for another, with specific properties for the latter.

```sql
ALTER SHADOW RULE shadow_rule(
  SOURCE=demo_ds,
  SHADOW=demo_ds_shadow,
  t_order(TYPE(NAME="SQL_HINT")),
  t_order_item(TYPE(NAME="VALUE_MATCH", PROPERTIES("operation"="insert","column"="user_id", "value"='1')))
);
```

--------------------------------

### ShardingSphere-Proxy Startup Success Log

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/migration/build

This log message indicates that ShardingSphere-Proxy has started successfully.

```log
[INFO ] [main] o.a.s.p.frontend.ShardingSphereProxy - ShardingSphere-Proxy start success

```

--------------------------------

### Install OpenJDK and SDKMAN! on Ubuntu

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/graalvm-native-image

Install OpenJDK 21 and SDKMAN! on Ubuntu for building ShardingSphere Proxy Native. This involves using apt, curl, and SDKMAN! commands to manage Java versions.

```bash
sudo apt install unzip zip -y
curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"
 sdk install java 21.0.7-ms
sdk use java 21.0.7-ms
```

--------------------------------

### Install Rancher Desktop on Windows

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/graalvm-native-image

Download and install Rancher Desktop using the winget command in PowerShell 7. This step is necessary for configuring the container engine, specifically dockerd (moby), for use with WSL2.

```powershell
winget install --id SUSE.RancherDesktop --source winget --skip-dependencies
```

--------------------------------

### Install and Configure Rancher Desktop

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/graalvm-native-image/development

Installs Rancher Desktop using winget and configures it to use the 'dockerd(moby)' container engine with specific daemon settings. It's recommended to open a new PowerShell 7 terminal after installation and before starting Rancher Desktop.

```powershell
winget install --id SUSE.RancherDesktop --source winget --skip-dependencies
# Open a new PowerShell 7 terminal
rdctl start --application.start-in-background --container-engine.name=moby --kubernetes.enabled=false

@'
{
  "min-api-version": "1.41",
  "features": {
    "containerd-snapshotter": true
  },
  "log-driver": "local"
}
'@ | rdctl shell sudo tee /etc/docker/daemon.json

rdctl shutdown
rdctl start --application.start-in-background --container-engine.name=moby --kubernetes.enabled=false
```

--------------------------------

### Binding Table Configuration Example

Source: https://shardingsphere.apache.org/document/current/en/features/sharding/concept

Demonstrates how to configure binding tables in ShardingSphere rules. Ensure numeric suffixes are used exclusively for sharding.

```yaml
rules:
- !SHARDING
  tables:
    t_order:
      actualDataNodes: ds_${0..1}.t_order_${0..1}
    t_order_item:
      actualDataNodes: ds_${0..1}.t_order_item_${0..1}
  bindingTables:
    - t_order, t_order_item

```

--------------------------------

### Docker Compose for Mostly Statically Linked Image

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/graalvm-native-image

Example Docker Compose setup for running ShardingSphere-Proxy with a mostly statically linked GraalVM Native Image. Customize volume mounts and ports as needed.

```yaml
services:
  apache-shardingsphere-proxy-native:
    image: apache/shardingsphere-proxy-native:5.5.3-SNAPSHOT-mostly
    volumes:
      - ./custom/conf:/opt/shardingsphere-proxy/conf
    ports:
      - "3307:3307"
```

--------------------------------

### Sample YAML Encryption Configuration

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/yaml-config/rules/encrypt

A complete example of a YAML configuration for ShardingSphere JDBC encryption, including data source setup, encryption rules for user tables, and definitions for AES, MD5, and CHAR_DIGEST_LIKE encryptors.

```yaml
dataSources:
  unique_ds:
    dataSourceClassName: com.zaxxer.hikari.HikariDataSource
    driverClassName: com.mysql.jdbc.Driver
    standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
    username: root
    password: 

rules:
- !ENCRYPT
  tables:
    t_user:
      columns:
        username:
          cipher:
            name: username
            encryptorName: aes_encryptor
          assistedQuery:
            name: assisted_query_username
            encryptorName: assisted_encryptor
          likeQuery:
            name: like_query_username
            encryptorName: like_encryptor
        pwd:
          cipher:
            name: pwd
            encryptorName: aes_encryptor
          assistedQuery:
            name: assisted_query_pwd
            encryptorName: assisted_encryptor
  encryptors:
    aes_encryptor:
      type: AES
      props:
        aes-key-value: 123456abc
        digest-algorithm-name: SHA-1
    assisted_encryptor:
      type: MD5
    like_encryptor:
      type: CHAR_DIGEST_LIKE

```

--------------------------------

### Read-write Splitting SQL Hint Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/common-config/sql-hint

Set `WRITE_ROUTE_ONLY=true` to force the SQL query to be executed on the write data source.

```sql
/* SHARDINGSPHERE_HINT: WRITE_ROUTE_ONLY=true */ SELECT * FROM t_order;
```

--------------------------------

### Install and Configure Java with vfox on Windows

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/graalvm-native-image

Install and configure OpenJDK 21 using vfox on Windows PowerShell 7. This involves installing vfox, updating the PowerShell profile, and then adding, installing, and using the specified Java version.

```powershell
winget install --id version-fox.vfox --source winget --exact
if (-not (Test-Path -Path $PROFILE)) { New-Item -Type File -Path $PROFILE -Force }; Add-Content -Path $PROFILE -Value 'Invoke-Expression "$(vfox activate pwsh)"'
# At this time, you need to open a new Powershell 7 terminal
vfox add java
vfox install java@21.0.7-ms
vfox use --global java@21.0.7-ms
```

--------------------------------

### SQL Hint Syntax Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/common-config/sql-hint

This is the general format for ShardingSphere SQL Hints. Ensure your SQL client retains comments, as some clients filter them by default.

```sql
/* SHARDINGSPHERE_HINT: {key} = {value}, {key} = {value} */ SELECT * FROM t_order;
```

--------------------------------

### Example Output of SHOW MASK ALGORITHM PLUGINS

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/plugin/show-mask-algorithm-plugins

This output displays the result of querying available mask algorithm plugins, showing their types, aliases, and descriptions.

```text
+------------------------------+--------------+-------------+
| type                         | type_aliases | description |
+------------------------------+--------------+-------------+
| MD5                          |              |             |
| KEEP_FIRST_N_LAST_M          |              |             |
| KEEP_FROM_X_TO_Y             |              |             |
| MASK_AFTER_SPECIAL_CHARS     |              |             |
| MASK_BEFORE_SPECIAL_CHARS    |              |             |
| MASK_FIRST_N_LAST_M          |              |             |
| MASK_FROM_X_TO_Y             |              |             |
| GENERIC_TABLE_RANDOM_REPLACE |              |             |
+------------------------------+--------------+-------------+
8 rows in set (0.13 sec)
```

--------------------------------

### Full Database and Table Route Example

Source: https://shardingsphere.apache.org/document/current/en/reference/sharding/route

Demonstrates a DQL query without shard keys that targets all real tables related to a logical table across all databases.

```sql
SELECT * FROM t_order WHERE good_prority IN (1, 10);
```

--------------------------------

### Install GraalVM CE via SDKMAN! on Ubuntu

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/graalvm-native-image/development

Installs GraalVM CE 24.0.2-graalce using SDKMAN! and sets it as the default Java version. Requires unzip and zip to be installed.

```bash
sudo apt install unzip zip -y
curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"
 sdk install java 24.0.2-graalce
sdk use java 24.0.2-graalce
```

--------------------------------

### Sample SQL Federation Configuration

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/yaml-config/rules/sql-federation

A sample YAML configuration demonstrating how to enable SQL Federation and set the initial capacity and maximum size for the execution plan cache.

```yaml
sqlFederation:
  sqlFederationEnabled: true
  allQueryUseSQLFederation: false
  executionPlanCache:
    initialCapacity: 2000
    maximumSize: 65535

```

--------------------------------

### Shadow DB YAML Configuration Sample

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/yaml-config/rules/shadow

A complete YAML configuration sample demonstrating how to set up data sources and Shadow DB rules, including specific table configurations and shadow algorithm definitions.

```yaml
dataSources:
   ds:
      url: jdbc:mysql://127.0.0.1:3306/ds?serverTimezone=UTC&useSSL=false
      username: root
      password:
      connectionTimeoutMilliseconds: 30000
      idleTimeoutMilliseconds: 60000
      maxLifetimeMilliseconds: 1800000
      maxPoolSize: 50
      minPoolSize: 1
   shadow_ds:
      url: jdbc:mysql://127.0.0.1:3306/shadow_ds?serverTimezone=UTC&useSSL=false
      username: root
      password:
      connectionTimeoutMilliseconds: 30000
      idleTimeoutMilliseconds: 60000
      maxLifetimeMilliseconds: 1800000
      maxPoolSize: 50
      minPoolSize: 1

rules:
- !SHADOW
  dataSources:
    shadowDataSource:
      productionDataSourceName: ds
      shadowDataSourceName: shadow_ds
  tables:
    t_order:
      dataSourceNames: 
        - shadowDataSource
      shadowAlgorithmNames: 
        - user_id_insert_match_algorithm
        - sql_hint_algorithm
  shadowAlgorithms:
    user_id_insert_match_algorithm:
      type: REGEX_MATCH
      props:
        operation: insert
        column: user_id
        regex: "[1]"
    sql_hint_algorithm:
      type: SQL_HINT

```

--------------------------------

### Install vfox and Java with GraalVM CE

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/graalvm-native-image/development

Installs vfox using winget and configures it to add, install, and use a specific version of Java compatible with GraalVM CE. Ensure to open a new PowerShell 7 terminal after modifying the profile.

```powershell
winget install --id version-fox.vfox --source winget --exact
if (-not (Test-Path -Path $PROFILE)) { New-Item -Type File -Path $PROFILE -Force }; Add-Content -Path $PROFILE -Value 'Invoke-Expression "$(vfox activate pwsh)"'
# At this time, developer need to open a new Powershell 7 terminal
vfox add java
vfox install java@24.0.2-graalce
vfox use --global java@24.0.2-graalce
```

--------------------------------

### Prepare Heterogeneous Source Database (MySQL)

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/migration/usage

Create a MySQL database with UTF8 character set. Define the 't_order' table with specified columns and primary key, then insert sample data.

```sql
DROP DATABASE IF EXISTS migration_ds_0;
CREATE DATABASE migration_ds_0 DEFAULT CHARSET utf8;

USE migration_ds_0

CREATE TABLE t_order (order_id INT NOT NULL, user_id INT NOT NULL, status VARCHAR(45) NULL, PRIMARY KEY (order_id));

INSERT INTO t_order (order_id, user_id, status) VALUES (1,2,'ok'),(2,4,'ok'),(3,6,'ok'),(4,1,'ok'),(5,3,'ok'),(6,5,'ok');

```

--------------------------------

### ESPRESSO Row Value Expression Examples

Source: https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/expr

Examples demonstrating how ESPRESSO converts Groovy-based row value expressions into actual values.

```plaintext
<ESPRESSO>t_order_${1..3}
```

```plaintext
<ESPRESSO>${['online', 'offline']}_table${1..3}
```

--------------------------------

### Show Key Generate Algorithm Plugins

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/plugin/show-key-generate-algorithm-plugins

Use this command to list all available key generation algorithm plugins. This is useful for understanding the key generation strategies supported by ShardingSphere.

```sql
SHOW KEY GENERATE ALGORITHM PLUGINS
```

```sql
SHOW KEY GENERATE ALGORITHM PLUGINS;
```

--------------------------------

### Stop Migration Check Process Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration-check

An example demonstrating how to stop a migration check process by providing the specific migration job ID.

```sql
START MIGRATION CHECK 'j010180026753ef0e25d3932d94d1673ba551';
```

--------------------------------

### Prepare Isomorphic Source Database

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/migration/usage

Create and connect to the source database, then define the 't_order' table with specified columns and primary key. Insert sample data into the table.

```sql
DROP DATABASE IF EXISTS migration_ds_0;
CREATE DATABASE migration_ds_0;

\c migration_ds_0

CREATE TABLE t_order (order_id INT NOT NULL, user_id INT NOT NULL, status VARCHAR(45) NULL, PRIMARY KEY (order_id));

INSERT INTO t_order (order_id, user_id, status) VALUES (1,2,'ok'),(2,4,'ok'),(3,6,'ok'),(4,1,'ok'),(5,3,'ok'),(6,5,'ok');

```

--------------------------------

### CDC Client Log Output Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/cdc/usage

This is an example of the log output generated by the CDC client when processing records. It shows the structure of the received data.

```log
records: [before {
  name: "order_id"
  value {
    type_url: "type.googleapis.com/google.protobuf.Empty"
  }
  ......


```

--------------------------------

### Register Migration Source Storage Unit with Connection Pool Parameters

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/register-migration-source-storage-unit

This example demonstrates how to register a migration source storage unit and configure connection pool parameters. The `PROPERTIES` clause accepts key-value pairs that correspond to connection pool parameter names. Supported types for values are int and String.

```sql
REGISTER MIGRATION SOURCE STORAGE UNIT ds_0 (
    URL="jdbc:mysql://127.0.0.1:3306/migration_ds_0?serverTimezone=UTC&useSSL=false",
    USER="root",
    PASSWORD="root",
    PROPERTIES("minPoolSize"="1","maxPoolSize"="20","idleTimeout"="60000")
);
```

--------------------------------

### ShardingSphere Agent Configuration Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-agent/usage/docker

Example configuration for ShardingSphere Agent, specifying tracing plugin properties like service name and exporter endpoint.

```yaml
plugins:
  tracing:
    OpenTelemetry:
      props:
        otel.service.name: "example"
        otel.exporter.otlp.traces.endpoint: "http://jaeger:4318"

```

--------------------------------

### Show Sharding Algorithm Plugins

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/plugin/show-sharding-algorithm-plugins

Use this command to list all available sharding algorithm plugins. The output includes the type, any aliases, and a description for each plugin.

```sql
SHOW SHARDING ALGORITHM PLUGINS
```

```sql
SHOW SHARDING ALGORITHM PLUGINS;
```

--------------------------------

### SysBench Environment Setup Commands

Source: https://shardingsphere.apache.org/document/current/en/test-manual/performance-test/sysbench-proxy-norules-test

Commands to prepare and clean up the database schema and data for SysBench testing. These ensure a consistent state before running the main stress test.

```bash
sysbench oltp_read_write --mysql-host=${DB_IP} --mysql-port=${DB_PORT} --mysql-user=${USER} --mysql-password=${PASSWD} --mysql-db=test --tables=10 --table-size=1000000 --report-interval=10 --time=100 --threads=200  cleanup
sysbench oltp_read_write --mysql-host=${DB_IP} --mysql-port=${DB_PORT} --mysql-user=${USER} --mysql-password=${PASSWD} --mysql-db=test --tables=10 --table-size=1000000 --report-interval=10 --time=100 --threads=200  prepare

```

--------------------------------

### Create Logical Database and Configure Storage Units

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/migration/usage

Use these SQL commands to create a logical database, register storage units, and define sharding rules for tables.

```sql
CREATE DATABASE sharding_db;

\c sharding_db

REGISTER STORAGE UNIT ds_2 (
    URL="jdbc:postgresql://127.0.0.1:5432/migration_ds_10",
    USER="postgres",
    PASSWORD="root",
    PROPERTIES("minPoolSize"="1","maxPoolSize"="20","idleTimeout"="60000")
), ds_3 (
    URL="jdbc:postgresql://127.0.0.1:5432/migration_ds_11",
    USER="postgres",
    PASSWORD="root",
    PROPERTIES("minPoolSize"="1","maxPoolSize"="20","idleTimeout"="60000")
), ds_4 (
    URL="jdbc:postgresql://127.0.0.1:5432/migration_ds_12",
    USER="postgres",
    PASSWORD="root",
    PROPERTIES("minPoolSize"="1","maxPoolSize"="20","idleTimeout"="60000")
);

CREATE SHARDING TABLE RULE t_order(
STORAGE_UNITS(ds_2,ds_3,ds_4),
SHARDING_COLUMN=order_id,
TYPE(NAME="hash_mod",PROPERTIES("sharding-count"="6")),
KEY_GENERATE_STRATEGY(COLUMN=order_id,TYPE(NAME="snowflake"))
);
```

--------------------------------

### Start ShardingSphere Proxy Native on Linux

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/startup/graalvm-native-image

Execute the ShardingSphere Proxy Native binary with the required port, configuration directory, and host parameters. Ensure you are in the correct directory before running.

```bash
cd ./shardingsphere/
cd ./distribution/proxy-native/target/apache-shardingsphere-5.5.3-SNAPSHOT-shardingsphere-proxy-bin/bin
./proxy-native "3307" "/tmp/conf" "0.0.0.0"
```

--------------------------------

### Start Presto with Docker Compose

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/optional-plugins/presto

This Docker Compose configuration starts a Presto node with Iceberg Connector and a local Hive Metastore. Ensure the `iceberg.properties` file is in the same directory.

```yaml
services:
  presto:
    image: prestodb/presto:0.296
    ports:
      - "8080:8080"
    volumes:
      - ./iceberg.properties:/opt/presto-server/etc/catalog/iceberg.properties
```

--------------------------------

### START MIGRATION CHECK SQL Syntax

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/migration/start-migration-check

Defines the grammar for the START MIGRATION CHECK command. The migrationJobId parameter is required and must be obtained from the SHOW MIGRATION LIST command.

```sql
StartMigrationCheck ::=
  'START' 'MIGRATION' 'CHECK' migrationJobId 

migrationJobId ::=
  string
```

--------------------------------

### Sharding Configuration Example

Source: https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/sharding

This snippet demonstrates a comprehensive sharding configuration, including table-specific rules, default strategies, binding tables, key generation, and inline sharding algorithms.

```yaml
rules:
- !SHARDING
  tables:
    t_order: 
      actualDataNodes: ds_${0..1}.t_order_${0..1}
      tableStrategy: 
        standard:
          shardingColumn: order_id
          shardingAlgorithmName: t_order_inline
    t_order_item:
      actualDataNodes: ds_${0..1}.t_order_item_${0..1}
      tableStrategy:
        standard:
          shardingColumn: order_id
          shardingAlgorithmName: t_order_item_inline
    t_account:
      actualDataNodes: ds_${0..1}.t_account_${0..1}
      tableStrategy:
        standard:
          shardingAlgorithmName: t_account_inline
  defaultShardingColumn: account_id
  bindingTables:
    - t_order,t_order_item
  defaultDatabaseStrategy:
    standard:
      shardingColumn: user_id
      shardingAlgorithmName: database_inline
  defaultTableStrategy:
    none:
  keyGenerateStrategies:
    t_order_order_id:
      keyGenerateType: column
      keyGeneratorName: snowflake
      logicTable: t_order
      keyGenerateColumn: order_id
    t_order_item_order_item_id:
      keyGenerateType: column
      keyGeneratorName: snowflake
      logicTable: t_order_item
      keyGenerateColumn: order_item_id
    t_account_account_id:
      keyGenerateType: column
      keyGeneratorName: snowflake
      logicTable: t_account
      keyGenerateColumn: account_id
  
  shardingAlgorithms:
    database_inline:
      type: INLINE
      props:
        algorithm-expression: ds_${user_id % 2}
    t_order_inline:
      type: INLINE
      props:
        algorithm-expression: t_order_${order_id % 2}
    t_order_item_inline:
      type: INLINE
      props:
        algorithm-expression: t_order_item_${order_id % 2}
    t_account_inline:
      type: INLINE
      props:
        algorithm-expression: t_account_${account_id % 2}
  keyGenerators:
    snowflake:
      type: SNOWFLAKE

- !BROADCAST
  tables:
    - t_address

```

--------------------------------

### Sharding Database with HintManager

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/special-api/sharding/hint

This example demonstrates how to force routing to a specific database using `setDatabaseShardingValue`. This is useful when table sharding is not required or when targeting a single database.

```java
// Sharding database and one database route with HintManager
String sql = "SELECT * FROM t_order";
try (HintManager hintManager = HintManager.getInstance();
     Connection conn = dataSource.getConnection();
     PreparedStatement preparedStatement = conn.prepareStatement(sql)) {
    hintManager.setDatabaseShardingValue(3);
    try (ResultSet rs = preparedStatement.executeQuery()) {
        while (rs.next()) {
            // ...
        }
    }
}

```

--------------------------------

### Register Storage Unit with HOST & PORT

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/rdl/storage-unit-definition/register-storage-unit

Use this syntax to register a storage unit by specifying host, port, database name, user, and password. Ensure the database is selected using the `USE` command prior to execution.

```sql
REGISTER STORAGE UNIT ds_0 (
    HOST="127.0.0.1",
    PORT=3306,
    DB="db_0",
    USER="root",
    PASSWORD="root"
);
```

--------------------------------

### Install Visual Studio Community 2022

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/graalvm-native-image/development

Installs Visual Studio 2022 Community Edition using winget. This is a prerequisite for C++ development tools required by GraalVM Native Image.

```powershell
winget install --id Microsoft.VisualStudio.2022.Community --source winget --exact
```

--------------------------------

### Prepare Source Database and Table

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/migration/usage

Create and populate the source database and table for the migration process. This includes defining the schema and inserting initial data.

```sql
DROP DATABASE IF EXISTS migration_ds_0;
CREATE DATABASE migration_ds_0 DEFAULT CHARSET utf8;

USE migration_ds_0

CREATE TABLE t_order (order_id INT NOT NULL, user_id INT NOT NULL, status VARCHAR(45) NULL, PRIMARY KEY (order_id));

INSERT INTO t_order (order_id, user_id, status) VALUES (1,2,'ok'),(2,4,'ok'),(3,6,'ok'),(4,1,'ok'),(5,3,'ok'),(6,5,'ok');


```

--------------------------------

### Preview SQL Execution Plan with MySQL Client

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/rul/preview-sql

Example of using the PREVIEW SQL command via a MySQL client. The output shows the data source name and the actual SQL statement that will be executed.

```sql
mysql> PREVIEW SELECT * FROM t_order;
+------------------+-----------------------+
| data_source_name | actual_sql            |
+------------------+-----------------------+
| su_1             | SELECT * FROM t_order |
+------------------+-----------------------+
1 row in set (0.18 sec)
```

--------------------------------

### Encryption Configuration Example

Source: https://shardingsphere.apache.org/document/current/en/reference/encrypt

Configure encryption for tables and columns, specifying cipher columns and encryptor names. This example uses AES encryption with a predefined key and SHA-1 digest algorithm.

```yaml
-!ENCRYPT
  encryptors:
    aes_encryptor:
      type: AES
      props:
        aes-key-value: 123456abc
        digest-algorithm-name: SHA-1
  tables:
    t_user:
      columns:
        pwd:
          cipher:
            name: pwd_cipher
            encryptorName: aes_encryptor
          assistedQuery:
            name: pwd_assisted_query
            encryptorName: pwd_assisted_query_cipher

```

--------------------------------

### Sample YAML Configuration for Broadcast Tables

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-jdbc/yaml-config/rules/broadcast

This sample demonstrates a complete YAML configuration including data sources and broadcast table rules. It shows how to define multiple data sources and then apply the broadcast rule to a specific table.

```yaml
dataSources:
  ds_0:
    dataSourceClassName: com.zaxxer.hikari.HikariDataSource
    driverClassName: com.mysql.jdbc.Driver
    standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds_0?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
    username: root
    password:
  ds_1:
    dataSourceClassName: com.zaxxer.hikari.HikariDataSource
    driverClassName: com.mysql.jdbc.Driver
    standardJdbcUrl: jdbc:mysql://localhost:3306/demo_ds_1?serverTimezone=UTC&useSSL=false&useUnicode=true&characterEncoding=UTF-8
    username: root
    password:

rules:
- !BROADCAST
  tables:
    - t_address
```

--------------------------------

### Show Shadow Algorithm Plugins Syntax

Source: https://shardingsphere.apache.org/document/current/en/user-manual/shardingsphere-proxy/distsql/syntax/ral/plugin/show-shadow-algorithm-plugins

Use this syntax to query all implementations of the org.apache.shardingsphere.shadow.spi.ShadowAlgorithm interface.

```sql
SHOW SHADOW ALGORITHM PLUGINS
```

```sql
SHOW SHADOW ALGORITHM PLUGINS;
```
Tokens:
Raw