Skip to content

Commit 6e58bb8

Browse files
linghengqianlinghengqian
committed
Add documentation for P6Spy support
1 parent af96795 commit 6e58bb8

File tree

27 files changed

+598
-173
lines changed

27 files changed

+598
-173
lines changed

‎docs/document/content/user-manual/shardingsphere-jdbc/graalvm-native-image/_index.cn.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ java.beans.Introspector was unintentionally initialized at build time. To see wh
4747
<plugin>
4848
<groupId>org.graalvm.buildtools</groupId>
4949
<artifactId>native-maven-plugin</artifactId>
50-
<version>0.10.3</version>
50+
<version>0.10.4</version>
5151
<extensions>true</extensions>
5252
<configuration>
5353
<buildArgs>
@@ -85,12 +85,12 @@ java.beans.Introspector was unintentionally initialized at build time. To see wh
8585

8686
```groovy
8787
plugins {
88-
id 'org.graalvm.buildtools.native' version '0.10.3'
88+
id 'org.graalvm.buildtools.native' version '0.10.4'
8989
}
9090
9191
dependencies {
9292
implementation 'org.apache.shardingsphere:shardingsphere-jdbc:${shardingsphere.version}'
93-
implementation(group: 'org.graalvm.buildtools', name: 'graalvm-reachability-metadata', version: '0.10.3', classifier: 'repository', ext: 'zip')
93+
implementation(group: 'org.graalvm.buildtools', name: 'graalvm-reachability-metadata', version: '0.10.4', classifier: 'repository', ext: 'zip')
9494
}
9595
9696
graalvmNative {

‎docs/document/content/user-manual/shardingsphere-jdbc/graalvm-native-image/_index.en.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ and the documentation of GraalVM Native Build Tools shall prevail.
4949
<plugin>
5050
<groupId>org.graalvm.buildtools</groupId>
5151
<artifactId>native-maven-plugin</artifactId>
52-
<version>0.10.3</version>
52+
<version>0.10.4</version>
5353
<extensions>true</extensions>
5454
<configuration>
5555
<buildArgs>
@@ -89,12 +89,12 @@ Reference https://github.com/graalvm/native-build-tools/issues/572 .
8989

9090
```groovy
9191
plugins {
92-
id 'org.graalvm.buildtools.native' version '0.10.3'
92+
id 'org.graalvm.buildtools.native' version '0.10.4'
9393
}
9494
9595
dependencies {
9696
implementation 'org.apache.shardingsphere:shardingsphere-jdbc:${shardingsphere.version}'
97-
implementation(group: 'org.graalvm.buildtools', name: 'graalvm-reachability-metadata', version: '0.10.3', classifier: 'repository', ext: 'zip')
97+
implementation(group: 'org.graalvm.buildtools', name: 'graalvm-reachability-metadata', version: '0.10.4', classifier: 'repository', ext: 'zip')
9898
}
9999
100100
graalvmNative {

‎docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/clickhouse/_index.cn.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,14 +98,20 @@ dataSources:
9898
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
9999
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
100100
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_0
101+
username: default
102+
password:
101103
ds_1:
102104
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
103105
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
104106
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_1
107+
username: default
108+
password:
105109
ds_2:
106110
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
107111
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
108112
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_2
113+
username: default
114+
password:
109115
rules:
110116
- !SHARDING
111117
tables:
@@ -305,14 +311,20 @@ dataSources:
305311
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
306312
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
307313
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_0?transactionSupport=true
314+
username: default
315+
password:
308316
ds_1:
309317
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
310318
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
311319
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_1?transactionSupport=true
320+
username: default
321+
password:
312322
ds_2:
313323
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
314324
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
315325
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_2?transactionSupport=true
326+
username: default
327+
password:
316328
rules:
317329
- !SHARDING
318330
tables:

‎docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/clickhouse/_index.en.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,20 @@ dataSources:
100100
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
101101
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
102102
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_0
103+
username: default
104+
password:
103105
ds_1:
104106
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
105107
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
106108
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_1
109+
username: default
110+
password:
107111
ds_2:
108112
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
109113
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
110114
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_2
115+
username: default
116+
password:
111117
rules:
112118
- !SHARDING
113119
tables:
@@ -311,14 +317,20 @@ dataSources:
311317
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
312318
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
313319
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_0?transactionSupport=true
320+
username: default
321+
password:
314322
ds_1:
315323
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
316324
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
317325
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_1?transactionSupport=true
326+
username: default
327+
password:
318328
ds_2:
319329
dataSourceClassName: com.zaxxer.hikari.HikariDataSource
320330
driverClassName: com.clickhouse.jdbc.ClickHouseDriver
321331
jdbcUrl: jdbc:ch://localhost:8123/demo_ds_2?transactionSupport=true
332+
username: default
333+
password:
322334
rules:
323335
- !SHARDING
324336
tables:

‎docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/hiveserver2/_index.cn.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -554,8 +554,8 @@ public class ExampleUtils {
554554
assert null == System.getProperty("fixture.hive.ds2.jdbc-url");
555555
String absolutePath = Paths.get("src/test/resources/init.sql").toAbsolutePath().toString();
556556
System.setProperty("fixture.hive.ds0.jdbc-url", "jdbc:hive2://localhost:10000/demo_ds_0;initFile=" + absolutePath);
557-
System.setProperty("fixture.hive.ds0.jdbc-url", "jdbc:hive2://localhost:10000/demo_ds_1;initFile=" + absolutePath);
558-
System.setProperty("fixture.hive.ds0.jdbc-url", "jdbc:hive2://localhost:10000/demo_ds_2;initFile=" + absolutePath);
557+
System.setProperty("fixture.hive.ds1.jdbc-url", "jdbc:hive2://localhost:10000/demo_ds_1;initFile=" + absolutePath);
558+
System.setProperty("fixture.hive.ds2.jdbc-url", "jdbc:hive2://localhost:10000/demo_ds_2;initFile=" + absolutePath);
559559
return new HikariDataSource(config);
560560
} finally {
561561
System.clearProperty("fixture.hive.ds0.jdbc-url");

‎docs/document/content/user-manual/shardingsphere-jdbc/optional-plugins/hiveserver2/_index.en.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,8 +562,8 @@ public class ExampleUtils {
562562
assert null == System.getProperty("fixture.hive.ds2.jdbc-url");
563563
String absolutePath = Paths.get("src/test/resources/init.sql").toAbsolutePath().toString();
564564
System.setProperty("fixture.hive.ds0.jdbc-url", "jdbc:hive2://localhost:10000/demo_ds_0;initFile=" + absolutePath);
565-
System.setProperty("fixture.hive.ds0.jdbc-url", "jdbc:hive2://localhost:10000/demo_ds_1;initFile=" + absolutePath);
566-
System.setProperty("fixture.hive.ds0.jdbc-url", "jdbc:hive2://localhost:10000/demo_ds_2;initFile=" + absolutePath);
565+
System.setProperty("fixture.hive.ds1.jdbc-url", "jdbc:hive2://localhost:10000/demo_ds_1;initFile=" + absolutePath);
566+
System.setProperty("fixture.hive.ds2.jdbc-url", "jdbc:hive2://localhost:10000/demo_ds_2;initFile=" + absolutePath);
567567
return new HikariDataSource(config);
568568
} finally {
569569
System.clearProperty("fixture.hive.ds0.jdbc-url");

‎docs/document/content/user-manual/shardingsphere-jdbc/special-api/transaction/seata.cn.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -609,3 +609,15 @@ public class CustomWebMvcConfigurer implements WebMvcConfigurer {
609609
5. 微服务实例 `a-service` 和 `b-service` 均为 Spring Boot 微服务，但使用的组件是 Spring WebFlux 而非 Spring WebMVC。
610610
在反应式编程 API 下 ShardingSphere JDBC 无法处理 R2DBC DataSource，仅可处理 JDBC DataSource。
611611
在使用 WebFlux 组件的 Spring Boot 微服务中应避免创建 ShardingSphere JDBC DataSource。
612+
613+
### Log 配置
614+
615+
在业务项目启动 Seata Client 后，可能看到如下的 Error Log。
616+
617+
```shell
618+
[ERROR] 2024-12-20 11:46:43.878 [ForkJoinPool.commonPool-worker-1] o.a.s.config.ConfigurationFactory - failed to load non-spring configuration :not found service provider for : org.apache.seata.config.ConfigurationProvider
619+
org.apache.seata.common.loader.EnhancedServiceNotFoundException: not found service provider for : org.apache.seata.config.ConfigurationProvider
620+
```
621+
622+
根据 https://github.com/apache/incubator-seata/issues/6886 ，抛出此异常是 Seata Client 的预期行为。
623+
用户可通过在业务项目的 classpath 放置 `logback.xml` 对 Seata Client 的日志加以配置。

‎docs/document/content/user-manual/shardingsphere-jdbc/special-api/transaction/seata.en.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -641,3 +641,15 @@ public class CustomWebMvcConfigurer implements WebMvcConfigurer {
641641
5. Both microservice instances `a-service` and `b-service` are Spring Boot microservices, but the components used are Spring WebFlux instead of Spring WebMVC.
642642
ShardingSphere JDBC cannot handle R2DBC DataSource under the reactive programming API, only JDBC DataSource.
643643
Avoid creating ShardingSphere JDBC DataSource in Spring Boot microservices using WebFlux components.
644+
645+
### Log Configuration
646+
647+
After starting Seata Client in a business project, you may see the following Error Log.
648+
649+
```shell
650+
[ERROR] 2024-12-20 11:46:43.878 [ForkJoinPool.commonPool-worker-1] o.a.s.config.ConfigurationFactory - failed to load non-spring configuration :not found service provider for : org.apache.seata.config.ConfigurationProvider
651+
org.apache.seata.common.loader.EnhancedServiceNotFoundException: not found service provider for : org.apache.seata.config.ConfigurationProvider
652+
```
653+
654+
According to https://github.com/apache/incubator-seata/issues/6886 , throwing this exception is the expected behavior of Seata Client.
655+
Users can configure the log of Seata Client by placing `logback.xml` in the classpath of the business project.

docs/document/content/user-manual/shardingsphere-jdbc/unsupported.cn.md renamed to docs/document/content/user-manual/shardingsphere-jdbc/unsupported/_index.cn.md

File renamed without changes.

docs/document/content/user-manual/shardingsphere-jdbc/unsupported.en.md renamed to docs/document/content/user-manual/shardingsphere-jdbc/unsupported/_index.en.md

File renamed without changes.

0 commit comments

Comments
 (0)