This is an automated email from the ASF dual-hosted git repository.
zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new c16f1ac3430 Update data-source.en.md (#19351)
c16f1ac3430 is described below
commit c16f1ac3430f172909ae60ca539c5bfef4f90c98
Author: Swastika Gupta <[email protected]>
AuthorDate: Tue Jul 19 12:57:57 2022 +0530
Update data-source.en.md (#19351)
---
docs/document/content/dev-manual/data-source.en.md | 125 +++++++++++++--------
1 file changed, 77 insertions(+), 48 deletions(-)
diff --git a/docs/document/content/dev-manual/data-source.en.md
b/docs/document/content/dev-manual/data-source.en.md
index 5cbf8852456..866fccba7be 100644
--- a/docs/document/content/dev-manual/data-source.en.md
+++ b/docs/document/content/dev-manual/data-source.en.md
@@ -5,51 +5,80 @@ weight = 4
chapter = true
+++
-## SPI Interface
-
-| SPI Name | Description |
-| ---------------------------- | ------------------------------------------- |
-| DatabaseType | Supported database types |
-| DialectTableMetaDataLoader | Use SQL dialect to load meta data rapidly |
-| DataSourcePoolMetaData | Data source connection pool metadata |
-| DataSourcePoolActiveDetector | Data source connection pool active detector |
-
-## Sample
-
-### DatabaseType
-
-| *Implementation Class* | *Description* |
-| ---------------------- | ----------------------- |
-| SQL92DatabaseType | SQL92 database type |
-| MySQLDatabaseType | MySQL database |
-| MariaDBDatabaseType | MariaDB database |
-| PostgreSQLDatabaseType | PostgreSQL database |
-| OracleDatabaseType | Oracle database |
-| SQLServerDatabaseType | SQLServer database |
-| H2DatabaseType | H2 database |
-| OpenGaussDatabaseType | OpenGauss database |
-
-### DialectTableMetaDataLoader
-
-| *Implementation Class* | *Description* |
-| ---------------------------- | ----------------------------------------- |
-| MySQLTableMetaDataLoader | Use MySQL dialect to load meta data |
-| OracleTableMetaDataLoader | Use Oracle dialect to load meta data |
-| PostgreSQLTableMetaDataLoader| Use PostgreSQL dialect to load meta data |
-| SQLServerTableMetaDataLoader | Use SQLServer dialect to load meta data |
-| H2TableMetaDataLoader | Use H2 dialect to load meta data |
-| OpenGaussTableMetaDataLoader | Use OpenGauss dialect to load meta data |
-
-### DataSourcePoolMetaData
-
-| *Implementation Class* | *Description* |
-|------------------------------|-----------------------------------|
-| DBCPDataSourcePoolMetaData | DBCP data source pool meta data |
-| HikariDataSourcePoolMetaData | Hikari data source pool meta data |
-
-### DataSourcePoolActiveDetector
-
-| *Implementation Class* | *Description*
|
-| ----------------------------------- |
---------------------------------------- |
-| DefaultDataSourcePoolActiveDetector | Default data source pool active
detector |
-| HikariDataSourcePoolActiveDetector | Hikari data source pool active
detector |
+## DatabaseType
+
+### Fully-qualified class name
+
+[`org.apache.shardingsphere.infra.database.type.DatabaseType`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/database/type/DatabaseType.java)
+
+### Definition
+
+Supported database types definition
+
+### Implementation classes
+
+| *Configuration Type* | *Description* |
*Fully-qualified class name* |
+| -------------------- | ----------------------------------------- |
---------------------------- |
+| SQL92 | SQL92 database type |
[`org.apache.shardingsphere.infra.database.type.dialect.SQL92DatabaseType`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/database/type/dialect/SQL92DatabaseType.java)
|
+| MySQL | MySQL database |
[`org.apache.shardingsphere.infra.database.type.dialect.MySQLDatabaseType`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/database/type/dialect/MySQLDatabaseType.java)
|
+| MariaDB | MariaDB database |
[`org.apache.shardingsphere.infra.database.type.dialect.MariaDBDatabaseType`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/database/type/dialect/MariaDBDatabaseType.java)
|
+| PostgreSQL | PostgreSQL database |
[`org.apache.shardingsphere.infra.database.type.dialect.PostgreSQLDatabaseType`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/database/type/dialect/PostgreSQLDatabaseType.java)
|
+| Oracle | Oracle database |
[`org.apache.shardingsphere.infra.database.type.dialect.OracleDatabaseType`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/database/type/dialect/OracleDatabaseType.java)
|
+| SQLServer | SQLServer database |
[`org.apache.shardingsphere.infra.database.type.dialect.SQLServerDatabaseType`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/database/type/dialect/SQLServerDatabaseType.java)
|
+| H2 | H2 database |
[`org.apache.shardingsphere.infra.database.type.dialect.H2DatabaseType`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/database/type/dialect/H2DatabaseType.java)
|
+| openGauss | OpenGauss database |
[`org.apache.shardingsphere.infra.database.type.dialect.OpenGaussDatabaseType`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/database/type/dialect/OpenGaussDatabaseType.java)
|
+
+## DialectSchemaMetaDataLoader
+
+### Fully-qualified class name
+
+[`org.apache.shardingsphere.infra.metadata.database.schema.loader.spi.DialectSchemaMetaDataLoader`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/metadata/database/schema/loader/spi/DialectSchemaMetaDataLoader.java)
+
+### Definition
+
+Use SQL dialect to load meta data rapidly
+
+### Implementation classes
+
+| *Configuration Type* | *Description* |
*Fully-qualified class name* |
+| -------------------- | ----------------------------------------- |
---------------------------- |
+| MySQL | Use MySQL dialect to load meta data |
[`org.apache.shardingsphere.infra.metadata.database.schema.loader.dialect.MySQLSchemaMetaDataLoader`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/metadata/database/schema/loader/dialect/MySQLSchemaMetaDataLoader.java)
|
+| Oracle | Use Oracle dialect to load meta data |
[`org.apache.shardingsphere.infra.metadata.database.schema.loader.dialect.OracleSchemaMetaDataLoader`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/metadata/database/schema/loader/dialect/OracleSchemaMetaDataLoader.java)
|
+| PostgreSQL | Use PostgreSQL dialect to load meta data |
[`org.apache.shardingsphere.infra.metadata.database.schema.loader.dialect.PostgreSQLSchemaMetaDataLoader`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/metadata/database/schema/loader/dialect/PostgreSQLSchemaMetaDataLoader.java)
|
+| SQLServer | Use SQLServer dialect to load meta data |
[`org.apache.shardingsphere.infra.metadata.database.schema.loader.dialect.SQLServerSchemaMetaDataLoader`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/metadata/database/schema/loader/dialect/SQLServerSchemaMetaDataLoader.java)
|
+| H2 | Use H2 dialect to load meta data |
[`org.apache.shardingsphere.infra.metadata.database.schema.loader.dialect.H2SchemaMetaDataLoader`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/metadata/database/schema/loader/dialect/H2SchemaMetaDataLoader.java)
|
+| openGauss | Use OpenGauss dialect to load meta data |
[`org.apache.shardingsphere.infra.metadata.database.schema.loader.dialect.OpenGaussSchemaMetaDataLoader`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/metadata/database/schema/loader/dialect/OpenGaussSchemaMetaDataLoader.java)
|
+
+## DataSourcePoolMetaData
+
+### Fully-qualified class name
+
+[`org.apache.shardingsphere.infra.datasource.pool.metadata.DataSourcePoolMetaData`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/datasource/pool/metadata/DataSourcePoolMetaData.java)
+
+### Definition
+
+Data source connection pool metadata
+
+### Implementation classes
+
+| *Configuration Type* | *Description* |
*Fully-qualified class name* |
+| -------------------- | ----------------------------------------- |
---------------------------- |
+| DBCPDataSourcePoolMetaData | DBCP data source pool meta data |
[`org.apache.shardingsphere.infra.datasource.pool.metadata.type.dbcp.DBCPDataSourcePoolMetaData`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/datasource/pool/metadata/type/dbcp/DBCPDataSourcePoolMetaData.java)
|
+| HikariDataSourcePoolMetaData | Hikari data source pool meta data |
[`org.apache.shardingsphere.infra.datasource.pool.metadata.type.hikari.HikariDataSourcePoolMetaData`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/datasource/pool/metadata/type/hikari/HikariDataSourcePoolMetaData.java)
|
+
+## DataSourcePoolActiveDetector
+
+### Fully-qualified class name
+
+[`org.apache.shardingsphere.infra.datasource.pool.destroyer.detector.DataSourcePoolActiveDetector`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/datasource/pool/destroyer/detector/DataSourcePoolActiveDetector.java)
+
+### Definition
+
+Data source connection pool active detector
+
+### Implementation classes
+
+| *Configuration Type* | *Description* |
*Fully-qualified class name* |
+| -------------------- | ----------------------------------------- |
---------------------------- |
+| Default | Default data source pool active detector |
[`org.apache.shardingsphere.infra.datasource.pool.destroyer.detector.type.DefaultDataSourcePoolActiveDetector`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/datasource/pool/destroyer/detector/type/DefaultDataSourcePoolActiveDetector.java)
|
+| HikariDataSourcePoolActiveDetector | Hikari data source pool active
detector |
[`org.apache.shardingsphere.infra.datasource.pool.destroyer.detector.type.HikariDataSourcePoolActiveDetector`](https://github.com/apache/shardingsphere/blob/master/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/datasource/pool/destroyer/detector/type/HikariDataSourcePoolActiveDetector.java)
|
