blob: e550e8de28a56e9206239bbd9cb819f0029b3e4b [file] [log] [blame]
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
<channel>
<title>开发者手册 on ShardingSphere</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/</link>
<description>Recent content in 开发者手册 on ShardingSphere</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<atom:link href="https://shardingsphere.apache.org/document/current/cn/dev-manual/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>运行模式</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/mode/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/mode/</guid>
<description>StandalonePersistRepository 全限定类名 org.apache.shardingsphere.mode.repository.standalone.StandalonePersistRepository
定义 单机模式配置信息持久化定义
已知实现 配置标识 详细说明 全限定类名 H2 H2-based persistence org.apache.shardingsphere.mode.repository.standalone.h2.H2Repository ClusterPersistRepository 全限定类名 org.apache.shardingsphere.mode.repository.cluster.ClusterPersistRepository
定义 集群模式配置信息持久化定义
已知实现 配置标识 详细说明 全限定类名 ZooKeeper 基于 ZooKeeper 的持久化 org.apache.shardingsphere.mode.repository.cluster.zookeeper.CuratorZookeeperRepository etcd 基于 Etcd 的持久化 org.apache.shardingsphere.mode.repository.cluster.etcd.EtcdRepository GovernanceWatcher 全限定类名 org.apache.shardingsphere.mode.manager.cluster.coordinator.registry.GovernanceWatcher
定义 治理监听器定义
已知实现 配置标识 详细说明 全限定类名 Types: ADDED, UPDATED, DELETED; WatchingKeys: /nodes/compute_nodes 计算节点状态变化监听器 org.</description>
</item>
<item>
<title>配置</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/configuration/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/configuration/</guid>
<description>RuleBuilder 全限定类名 org.apache.shardingsphere.infra.rule.builder.RuleBuilder
定义 用于将用户配置转化为规则对象的接口
已知实现 配置标识 详细说明 全限定类名 AuthorityRuleConfiguration 用于将权限用户配置转化为权限规则对象 org.apache.shardingsphere.authority.rule.builder.AuthorityRuleBuilder SQLParserRuleConfiguration 用于将 SQL 解析用户配置转化为 SQL 解析规则对象 org.apache.shardingsphere.parser.rule.builder.SQLParserRuleBuilder TransactionRuleConfiguration 用于将事务用户配置转化为事务规则对象 org.apache.shardingsphere.transaction.rule.builder.TransactionRuleBuilder SingleTableRuleConfiguration 用于将单表用户配置转化为单表规则对象 org.apache.shardingsphere.singletable.rule.builder.SingleTableRuleBuilder ShardingRuleConfiguration 用于将分片用户配置转化为分片规则对象 org.apache.shardingsphere.sharding.rule.builder.ShardingRuleBuilder AlgorithmProvidedShardingRuleConfiguration 用于将基于算法的分片用户配置转化为分片规则对象 org.apache.shardingsphere.sharding.rule.builder.AlgorithmProvidedShardingRuleBuilder ReadwriteSplittingRuleConfiguration 用于将读写分离用户配置转化为读写分离规则对象 org.apache.shardingsphere.readwritesplitting.rule.builder.ReadwriteSplittingRuleBuilder AlgorithmReadwriteSplittingRuleConfiguration 用于将基于算法的读写分离用户配置转化为读写分离规则对象 org.apache.shardingsphere.readwritesplitting.rule.builder.AlgorithmProvidedReadwriteSplittingRuleBuilder DatabaseDiscoveryRuleConfiguration 用于将数据库发现用户配置转化为数据库发现规则对象 org.apache.shardingsphere.dbdiscovery.rule.builder.DatabaseDiscoveryRuleBuilder AlgorithmDatabaseDiscoveryRuleConfiguration 用于将基于算法的数据库发现用户配置转化为数据库发现规则对象 org.apache.shardingsphere.dbdiscovery.rule.builder.AlgorithmProvidedDatabaseDiscoveryRuleBuilder EncryptRuleConfiguration 用于将加密用户配置转化为加密规则对象 org.</description>
</item>
<item>
<title>内核</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/kernel/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/kernel/</guid>
<description>SQLRouter 全限定类名 org.apache.shardingsphere.infra.route.SQLRouter
定义 用于处理路由结果
已知实现 配置标识 详细说明 全限定类名 SingleTableRule 用于处理单表路由结果 org.apache.shardingsphere.singletable.route.SingleTableSQLRouter ShardingRule 用于处理分片路由结果 org.apache.shardingsphere.sharding.route.engine.ShardingSQLRouter ReadwriteSplittingRule 用于处理读写分离路由结果 org.apache.shardingsphere.readwritesplitting.route.ReadwriteSplittingSQLRouter DatabaseDiscoveryRule 用于处理数据库发现路由结果 org.apache.shardingsphere.dbdiscovery.route.DatabaseDiscoverySQLRouter ShadowRule 用于处理影子库路由结果 org.apache.shardingsphere.shadow.route.ShadowSQLRouter SQLRewriteContextDecorator 全限定类名 org.apache.shardingsphere.infra.rewrite.context.SQLRewriteContextDecorator
定义 用于处理 SQL 改写结果
已知实现 配置标识 详细说明 全限定类名 ShardingRule 用于处理分片 SQL 改写结果 org.apache.shardingsphere.sharding.rewrite.context.ShardingSQLRewriteContextDecorator EncryptRule 用于处理加密 SQL 改写结果 org.</description>
</item>
<item>
<title>数据源</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/data-source/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/data-source/</guid>
<description>SPI 接口 SPI 名称 详细说明 DatabaseType 支持的数据库类型 DialectTableMetaDataLoader 用于使用数据库方言快速加载元数据 DataSourcePoolMetaData 数据源连接池元数据 DataSourcePoolActiveDetector 数据源连接池活跃探测器 示例 DatabaseType 已知实现类 详细说明 SQL92DatabaseType 遵循 SQL92 标准的数据库类型 MySQLDatabaseType MySQL 数据库 MariaDBDatabaseType MariaDB 数据库 PostgreSQLDatabaseType PostgreSQL 数据库 OracleDatabaseType Oracle 数据库 SQLServerDatabaseType SQLServer 数据库 H2DatabaseType H2 数据库 OpenGaussDatabaseType OpenGauss 数据库 DialectTableMetaDataLoader 已知实现类 详细说明 MySQLTableMetaDataLoader 使用 MySQL 方言加载元数据 OracleTableMetaDataLoader 使用 Oracle 方言加载元数据 PostgreSQLTableMetaDataLoader 使用 PostgreSQL 方言加载元数据 SQLServerTableMetaDataLoader 使用 SQLServer 方言加载元数据 H2TableMetaDataLoader 使用 H2 方言加载元数据 OpenGaussTableMetaDataLoader 使用 OpenGauss 方言加载元数据 DataSourcePoolMetaData 已知实现类 详细说明 DBCPDataSourcePoolMetaData DBCP 数据库连接池元数据 HikariDataSourcePoolMetaData Hikari 数据源连接池元数据 C3P0DataSourcePoolMetaData C3P0 数据源连接池元数据 DataSourcePoolActiveDetector 已知实现类 详细说明 DefaultDataSourcePoolActiveDetector 默认数据源连接池活跃探测器 HikariDataSourcePoolActiveDetector Hikari 数据源连接池活跃探测器 </description>
</item>
<item>
<title>SQL 解析</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/sql-parser/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/sql-parser/</guid>
<description>SPI 接口 DatabaseTypedSQLParserFacade SPI 名称 详细说明 DatabaseTypedSQLParserFacade 配置用于 SQL 解析的词法分析器和语法分析器入口 SQLVisitorFacade SPI 名称 详细说明 SQLVisitorFacade SQL 语法树访问器入口 示例 DatabaseTypedSQLParserFacade Implementation Class Description MySQLParserFacade 基于 MySQL 的 SQL 解析器入口 PostgreSQLParserFacade 基于 PostgreSQL 的 SQL 解析器入口 SQLServerParserFacade 基于 SQLServer 的 SQL 解析器入口 OracleParserFacade 基于 Oracle 的 SQL 解析器入口 SQL92ParserFacade 基于 SQL92 的 SQL 解析器入口 OpenGaussParserFacade 基于 openGauss 的 SQL 解析器入口 SQLVisitorFacade SPI 名称 详细说明 SQLVisitorFacade SQL 语法树访问器入口 </description>
</item>
<item>
<title>代理端</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/proxy/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/proxy/</guid>
<description>DatabaseProtocolFrontendEngine 全限定类名 org.apache.shardingsphere.proxy.frontend.spi.DatabaseProtocolFrontendEngine
定义 用于 ShardingSphere-Proxy 解析与适配访问数据库的协议
已知实现 配置标识 详细说明 全限定类名 MySQL MySQL 协议实现 org.apache.shardingsphere.proxy.frontend.mysql.MySQLFrontendEngine PostgreSQL PostgreSQL 协议实现 org.apache.shardingsphere.proxy.frontend.postgresql.PostgreSQLFrontendEngine openGauss openGauss 协议实现 org.apache.shardingsphere.proxy.frontend.opengauss.OpenGaussFrontendEngine AuthorityProvideAlgorithm 全限定类名 org.apache.shardingsphere.authority.spi.AuthorityProviderAlgorithm
定义 用户权限加载逻辑
已知实现 配置标识 详细说明 全限定类名 ALL_PERMITTED 默认授予所有权限(不鉴权) org.apache.shardingsphere.authority.provider.simple.AllPermittedPrivilegesProviderAlgorithm DATABASE_PERMITTED 通过属性 user-database-mappings 配置的权限 org.apache.shardingsphere.authority.provider.database.DatabasePermittedPrivilegesProviderAlgorithm </description>
</item>
<item>
<title>数据分片</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/sharding/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/sharding/</guid>
<description>SPI 接口 SPI 名称 详细说明 ShardingAlgorithm 分片算法 KeyGenerateAlgorithm 分布式主键生成算法 ShardingAuditAlgorithm 分片审计算法 DatetimeService 获取当前时间进行路由 DatabaseSQLEntry 获取当前时间的数据库方言 示例 ShardingAlgorithm 已知实现类 详细说明 BoundaryBasedRangeShardingAlgorithm 基于分片边界的范围分片算法 VolumeBasedRangeShardingAlgorithm 基于分片容量的范围分片算法 ComplexInlineShardingAlgorithm 基于行表达式的复合分片算法 AutoIntervalShardingAlgorithm 基于可变时间范围的分片算法 ClassBasedShardingAlgorithm 基于自定义类的分片算法 HintInlineShardingAlgorithm 基于行表达式的 Hint 分片算法 IntervalShardingAlgorithm 基于固定时间范围的分片算法 HashModShardingAlgorithm 基于哈希取模的分片算法 InlineShardingAlgorithm 基于行表达式的分片算法 ModShardingAlgorithm 基于取模的分片算法 CosIdModShardingAlgorithm 基于 CosId 的取模分片算法 CosIdIntervalShardingAlgorithm 基于 CosId 的固定时间范围的分片算法 CosIdSnowflakeIntervalShardingAlgorithm 基于 CosId 的雪花ID固定时间范围的分片算法 KeyGenerateAlgorithm 已知实现类 详细说明 SnowflakeKeyGenerateAlgorithm 基于雪花算法的分布式主键生成算法 UUIDKeyGenerateAlgorithm 基于 UUID 的分布式主键生成算法 CosIdKeyGenerateAlgorithm 基于 CosId 的分布式主键生成算法 CosIdSnowflakeKeyGenerateAlgorithm 基于 CosId 的雪花算法分布式主键生成算法 NanoIdKeyGenerateAlgorithm 基于 NanoId 的分布式主键生成算法 ShardingAuditAlgorithm 已知实现类 详细说明 DMLShardingConditionsShardingAuditAlgorithm 禁止不带分片键的DML审计算法 DatetimeService 已知实现类 详细说明 DatabaseDatetimeServiceDelegate 从数据库中获取当前时间进行路由 SystemDatetimeService 从应用系统时间中获取当前时间进行路由 DatabaseSQLEntry 已知实现类 详细说明 MySQLDatabaseSQLEntry 从 MySQL 获取当前时间的数据库方言 PostgreSQLDatabaseSQLEntry 从 PostgreSQL 获取当前时间的数据库方言 OracleDatabaseSQLEntry 从 Oracle 获取当前时间的数据库方言 SQLServerDatabaseSQLEntry 从 SQLServer 获取当前时间的数据库方言 </description>
</item>
<item>
<title>读写分离</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/readwrite-splitting/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/readwrite-splitting/</guid>
<description>SPI 接口 ReadQueryLoadBalanceAlgorithm SPI 名称 详细说明 ReadQueryLoadBalanceAlgorithm 读库负载均衡算法 示例 ReadQueryLoadBalanceAlgorithm 已知实现类 详细说明 RoundRobinReadQueryLoadBalanceAlgorithm 基于轮询的读库负载均衡算法 RandomReadQueryLoadBalanceAlgorithm 基于随机的读库负载均衡算法 WeightReadQueryLoadBalanceAlgorithm 基于权重的读库负载均衡算法 TransactionRandomReadQueryLoadBalanceAlgorithm 无论是否在事务中,读请求采用随机策略路由到多个读库 TransactionRoundRobinReadQueryLoadBalanceAlgorithm 无论是否在事务中,读请求采用轮询策略路由到多个读库 TransactionWeightReadQueryLoadBalanceAlgorithm 无论是否在事务中,读请求采用权重策略路由到多个读库 FixedReplicaRandomReadQueryLoadBalanceAlgorithm 显示开启事务,读请求采用随机策略路由到一个固定读库;不开事务,每次读流量使用指定算法路由到不同的读库 FixedReplicaRoundRobinReadQueryLoadBalanceAlgorithm 显示开启事务,读请求采用轮询策略路由到一个固定读库;不开事务,每次读流量使用指定算法路由到不同的读库 FixedReplicaWeightReadQueryLoadBalanceAlgorithm 显示开启事务,读请求采用权重策略路由到多个读库;不开事务,每次读流量使用指定算法路由到不同的读库 FixedPrimaryReadQueryLoadBalanceAlgorithm 读请求全部路由到主库 </description>
</item>
<item>
<title>高可用</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/ha/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/ha/</guid>
<description>DatabaseDiscoveryProviderAlgorithm 全限定类名 org.apache.shardingsphere.dbdiscovery.spi.DatabaseDiscoveryProviderAlgorithm
定义 数据库发现提供算法的定义
已知实现 配置标识 详细说明 全限定类名 MySQL.MGR 基于 MySQL MGR 的数据库发现算法 org.apache.shardingsphere.dbdiscovery.mysql.type.MGRMySQLDatabaseDiscoveryProviderAlgorithm MySQL.NORMAL_REPLICATION 基于 MySQL 主从同步的数据库发现算法 org.apache.shardingsphere.dbdiscovery.mysql.type.MySQLNormalReplicationDatabaseDiscoveryProviderAlgorithm openGauss.NORMAL_REPLICATION 基于 openGauss 主从同步的数据库发现算法 org.apache.shardingsphere.dbdiscovery.opengauss.OpenGaussNormalReplicationDatabaseDiscoveryProviderAlgorithm </description>
</item>
<item>
<title>分布式事务</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/transaction/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/transaction/</guid>
<description>ShardingSphereTransactionManager 全限定类名 org.apache.shardingsphere.transaction.spi.ShardingSphereTransactionManager
定义 分布式事务管理器
已知实现 配置标识 详细说明 全限定类名 XA 基于 XA 的分布式事务管理器 org.apache.shardingsphere.transaction.xa.XAShardingSphereTransactionManager BASE 基于 Seata 的分布式事务管理器 org.apache.shardingsphere.transaction.base.seata.at.SeataATShardingSphereTransactionManager XATransactionManagerProvider 全限定类名 org.apache.shardingsphere.transaction.xa.spi.XATransactionManagerProvider
定义 XA 分布式事务管理器
已知实现 配置标识 详细说明 全限定类名 Atomikos 基于 Atomikos 的 XA 分布式事务管理器 org.apache.shardingsphere.transaction.xa.atomikos.manager.AtomikosTransactionManagerProvider| Narayana 基于 Narayana 的 XA 分布式事务管理器 org.apache.shardingsphere.transaction.xa.narayana.manager.NarayanaXATransactionManagerProvider| Bitronix 基于 Bitronix 的 XA 分布式事务管理器 org.</description>
</item>
<item>
<title>SQL 检查</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/sql-check/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/sql-check/</guid>
<description>SPI 接口 SPI 名称 详细说明 SQLChecker SQL 检查器 示例 SQLChecker 已知实现类 详细说明 AuthorityChecker 权限检查器 ShardingAuditChecker 分片审计检查器 </description>
</item>
<item>
<title>数据加密</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/encrypt/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/encrypt/</guid>
<description>SPI 接口 SPI 名称 详细说明 EncryptAlgorithm 数据加密算法 示例 EncryptAlgorithm 已知实现类 详细说明 MD5EncryptAlgorithm 基于 MD5 的数据加密算法 AESEncryptAlgorithm 基于 AES 的数据加密算法 RC4EncryptAlgorithm 基于 RC4 的数据加密算法 SM4EncryptAlgorithm 基于 SM4 的数据加密算法 SM3EncryptAlgorithm 基于 SM3 的数据加密算法 </description>
</item>
<item>
<title>影子库</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/shadow/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/shadow/</guid>
<description>SPI 接口 完全限定的类名 org.apache.shardingsphere.shadow.spi.ShadowAlgorithm
SPI 名称 详细说明 ShadowAlgorithm 影子库路由算法 示例 ShadowAlgorithm 已知实现类 详细说明 完全限定的类名 ColumnValueMatchedShadowAlgorithm 基于字段值匹配影子算法 org.apache.shardingsphere.shadow.algorithm.shadow.column.ColumnValueMatchedShadowAlgorithm ColumnRegexMatchedShadowAlgorithm 基于字段值正则匹配影子算法 org.apache.shardingsphere.shadow.algorithm.shadow.column.ColumnRegexMatchedShadowAlgorithm SimpleHintShadowAlgorithm 基于 Hint 简单匹配影子算法 org.apache.shardingsphere.shadow.algorithm.shadow.hint.SimpleHintShadowAlgorithm </description>
</item>
<item>
<title>可观察性</title>
<link>https://shardingsphere.apache.org/document/current/cn/dev-manual/agent/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/cn/dev-manual/agent/</guid>
<description>PluginBootService 全限定类名 org.apache.shardingsphere.agent.spi.boot.PluginBootService
定义 插件启动服务定义接口
已知实现 配置标识 详细说明 全限定类名 Prometheus Prometheus plugin 启动类 org.apache.shardingsphere.agent.metrics.prometheus.service.PrometheusPluginBootService Logging Logging plugin 启动类 org.apache.shardingsphere.agent.plugin.logging.base.service.BaseLoggingPluginBootService Jaeger Jaeger plugin 启动类 org.apache.shardingsphere.agent.plugin.tracing.jaeger.service.JaegerTracingPluginBootService OpenTelemetry OpenTelemetryTracing plugin 启动类 org.apache.shardingsphere.agent.plugin.tracing.opentelemetry.service.OpenTelemetryTracingPluginBootService OpenTracing OpenTracing plugin 启动类 org.apache.shardingsphere.agent.plugin.tracing.opentracing.service.OpenTracingPluginBootService Zipkin Zipkin plugin 启动类 org.apache.shardingsphere.agent.plugin.tracing.zipkin.service.ZipkinTracingPluginBootService PluginDefinitionService 全限定类名 org.apache.shardingsphere.agent.spi.definition.PluginDefinitionService
定义 探针插件定义服务接口
已知实现 配置标识 详细说明 全限定类名 Prometheus Prometheus 插件定义 org.</description>
</item>
</channel>
</rss>