blob: 657eba41d921b12bf44946bfa509701b88ee46a6 [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>Dev Manual on ShardingSphere</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/</link>
<description>Recent content in Dev Manual on ShardingSphere</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<atom:link href="https://shardingsphere.apache.org/document/current/en/dev-manual/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Mode</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/mode/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/mode/</guid>
<description>StandalonePersistRepository Fully-qualified class name org.apache.shardingsphere.mode.repository.standalone.StandalonePersistRepository
Definition Standalone mode configuration information persistence definition
Implementation classes Configuration Type Description Fully-qualified class name H2 H2-based persistence org.apache.shardingsphere.mode.repository.standalone.h2.H2Repository ClusterPersistRepository Fully-qualified class name org.apache.shardingsphere.mode.repository.cluster.ClusterPersistRepository
Definition Cluster mode configuration information persistence definition
Implementation classes Configuration Type Description Fully-qualified class name ZooKeeper ZooKeeper-based persistence org.apache.shardingsphere.mode.repository.cluster.zookeeper.CuratorZookeeperRepository etcd Etcd-based persistence org.</description>
</item>
<item>
<title>Configuration</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/configuration/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/configuration/</guid>
<description>RuleBuilder Fully-qualified class name org.apache.shardingsphere.infra.rule.builder.RuleBuilder
Definition Used to convert user configurations into rule objects
Implementation classes Configuration Type Description Fully-qualified class name AuthorityRuleConfiguration Used to convert authority user configuration into authority rule objects org.apache.shardingsphere.authority.rule.builder.AuthorityRuleBuilder SQLParserRuleConfiguration Used to convert SQL parser user configuration into SQL parser rule objects org.apache.shardingsphere.parser.rule.builder.SQLParserRuleBuilder TransactionRuleConfiguration Used to convert transaction user configuration into transaction rule objects org.</description>
</item>
<item>
<title>Kernel</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/kernel/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/kernel/</guid>
<description>SQLRouter Fully-qualified class name org.apache.shardingsphere.infra.route.SQLRouter
Definition Used to process routing results
Implementation classes Configuration type Description Fully-qualified class name SingleTableRule.class Used to process single-table routing results org.apache.shardingsphere.singletable.route.SingleTableSQLRouter ShardingRule.class Used to process sharding routing results org.apache.shardingsphere.sharding.route.engine.ShardingSQLRouter ReadwriteSplittingRule.class Used to process read-write splitting routing results org.apache.shardingsphere.readwritesplitting.route.ReadwriteSplittingSQLRouter DatabaseDiscoveryRule.class Used to process database discovery routing results org.apache.shardingsphere.dbdiscovery.route.DatabaseDiscoverySQLRouter ShadowRule.class Used to process shadow database routing results org.</description>
</item>
<item>
<title>DataSource</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/data-source/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/data-source/</guid>
<description>DatabaseType Fully-qualified class name org.apache.shardingsphere.infra.database.type.DatabaseType
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 MySQL MySQL database org.apache.shardingsphere.infra.database.type.dialect.MySQLDatabaseType MariaDB MariaDB database org.apache.shardingsphere.infra.database.type.dialect.MariaDBDatabaseType PostgreSQL PostgreSQL database org.apache.shardingsphere.infra.database.type.dialect.PostgreSQLDatabaseType Oracle Oracle database org.apache.shardingsphere.infra.database.type.dialect.OracleDatabaseType SQLServer SQLServer database org.apache.shardingsphere.infra.database.type.dialect.SQLServerDatabaseType H2 H2 database org.apache.shardingsphere.infra.database.type.dialect.H2DatabaseType openGauss OpenGauss database org.</description>
</item>
<item>
<title>SQL Parser</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/sql-parser/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/sql-parser/</guid>
<description>DatabaseTypedSQLParserFacade Fully-qualified class name org.apache.shardingsphere.sql.parser.spi.DatabaseTypedSQLParserFacade
Definition Database typed SQL parser facade service definition
Implementation classes Configuration Type Description Fully-qualified class name MySQL SQL parser entry based on MySQL org.apache.shardingsphere.sql.parser.mysql.parser.MySQLParserFacade PostgreSQL SQL parser entry based on PostgreSQL org.apache.shardingsphere.sql.parser.postgresql.parser.PostgreSQLParserFacade SQLServer SQL parser entry based on SQLServer org.apache.shardingsphere.sql.parser.sqlserver.parser.SQLServerParserFacade Oracle SQL parser entry based on Oracle org.apache.shardingsphere.sql.parser.oracle.parser.OracleParserFacade SQL92 SQL parser entry based on SQL92 org.</description>
</item>
<item>
<title>Proxy</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/proxy/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/proxy/</guid>
<description>DatabaseProtocolFrontendEngine Fully-qualified class name org.apache.shardingsphere.proxy.frontend.spi.DatabaseProtocolFrontendEngine
Definition Protocols for ShardingSphere-Proxy to parse and adapt for accessing databases.
Implementation classes Configuration Type Description Fully-qualified class name MySQL Protocol implementation for MySQL org.apache.shardingsphere.proxy.frontend.mysql.MySQLFrontendEngine PostgreSQL Protocol implementation for PostgreSQL org.apache.shardingsphere.proxy.frontend.postgresql.PostgreSQLFrontendEngine openGauss Protocol implementation for openGauss org.apache.shardingsphere.proxy.frontend.opengauss.OpenGaussFrontendEngine AuthorityProvideAlgorithm Fully-qualified class name org.apache.shardingsphere.authority.spi.AuthorityProviderAlgorithm
Definition Loading logic for user permission.
Implementation classes Configuration Type Description Fully-qualified class name ALL_PERMITTED Grant all permissions by default (no forensics) org.</description>
</item>
<item>
<title>Data Sharding</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/sharding/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/sharding/</guid>
<description>ShardingAlgorithm Fully-qualified class name org.apache.shardingsphere.sharding.spi.ShardingAlgorithm
Definition Sharding Algorithm definition
Implementation classes Configuration Type Auto Create Tables Description Fully-qualified class name MOD Y Modulo sharding algorithm org.apache.shardingsphere.sharding.algorithm.sharding.mod.ModShardingAlgorithm HASH_MOD Y Hash modulo sharding algorithm org.apache.shardingsphere.sharding.algorithm.sharding.mod.HashModShardingAlgorithm BOUNDARY_RANGE Y Boundary based range sharding algorithm org.apache.shardingsphere.sharding.algorithm.sharding.range.BoundaryBasedRangeShardingAlgorithm VOLUME_RANGE Y Volume based range sharding algorithm org.apache.shardingsphere.sharding.algorithm.sharding.range.VolumeBasedRangeShardingAlgorithm AUTO_INTERVAL Y Mutable interval sharding algorithm org.</description>
</item>
<item>
<title>Readwrite-splitting</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/readwrite-splitting/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/readwrite-splitting/</guid>
<description>ReadQueryLoadBalanceAlgorithm Fully-qualified class name org.apache.shardingsphere.readwritesplitting.spi.ReadQueryLoadBalanceAlgorithm
Definition Read query load balance algorithm&amp;rsquo;s definition
Implementation classes Configuration Type Description Fully-qualified class name ROUND_ROBIN the read database load balancer algorithm based on polling org.apache.shardingsphere.readwritesplitting.algorithm.loadbalance.RoundRobinReadQueryLoadBalanceAlgorithm RANDOM the read database load balancer algorithm based on random org.apache.shardingsphere.readwritesplitting.algorithm.loadbalance.RandomReadQueryLoadBalanceAlgorithm WEIGHT the read database load balancer algorithm based on weight org.apache.shardingsphere.readwritesplitting.algorithm.loadbalance.WeightReadQueryLoadBalanceAlgorithm TRANSACTION_RANDOM Whether in a transaction or not, read requests are routed to multiple replicas using a random strategy org.</description>
</item>
<item>
<title>HA</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/ha/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/ha/</guid>
<description>DatabaseDiscoveryProviderAlgorithm Fully-qualified class name org.apache.shardingsphere.dbdiscovery.spi.DatabaseDiscoveryProviderAlgorithm
Definition Database discovery provider algorithm&amp;rsquo;s definition
Implementation classes Configuration Type Description Fully-qualified class name MySQL.MGR MySQL MGR-based database discovery provider algorithm org.apache.shardingsphere.dbdiscovery.mysql.type.MGRMySQLDatabaseDiscoveryProviderAlgorithm MySQL.NORMAL_REPLICATION Database discovery provider algorithm of MySQL’s replication org.apache.shardingsphere.dbdiscovery.mysql.type.MySQLNormalReplicationDatabaseDiscoveryProviderAlgorithm openGauss.NORMAL_REPLICATION Database discovery provider algorithm of openGauss’s replication org.apache.shardingsphere.dbdiscovery.opengauss.OpenGaussNormalReplicationDatabaseDiscoveryProviderAlgorithm </description>
</item>
<item>
<title>Distributed Transaction</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/transaction/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/transaction/</guid>
<description>ShardingSphereTransactionManager Fully-qualified class name org.apache.shardingsphere.transaction.spi.ShardingSphereTransactionManager
Definition ShardingSphere transaction manager service definition
Implementation classes Configuration Type Description Fully-qualified class name XA XA distributed transaction manager org.apache.shardingsphere.transaction.xa.XAShardingSphereTransactionManager BASE Seata distributed transaction manager org.apache.shardingsphere.transaction.base.seata.at.SeataATShardingSphereTransactionManager XATransactionManagerProvider Fully-qualified class name org.apache.shardingsphere.transaction.xa.spi.XATransactionManagerProvider
Definition XA transaction manager provider definition
Implementation classes Configuration Type Description Fully-qualified class name Atomikos XA distributed transaction manager based on Atomikos org.</description>
</item>
<item>
<title>SQL Checker</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/sql-check/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/sql-check/</guid>
<description>SQLChecker Fully-qualified class name org.apache.shardingsphere.infra.executor.check.SQLChecker
Definition SQL checker class definition
Implementation classes Configuration Type Description Fully-qualified class name AuthorityRule.class Authority checker org.apache.shardingsphere.authority.checker.AuthorityChecker ShardingRule.class Sharding audit checker org.apache.shardingsphere.sharding.checker.audit.ShardingAuditChecker </description>
</item>
<item>
<title>Encryption</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/encrypt/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/encrypt/</guid>
<description>EncryptAlgorithm Fully-qualified class name org.apache.shardingsphere.encrypt.spi.EncryptAlgorithm
Definition Data encrypt algorithm definition
Implementation classes Configuration Type Description Fully-qualified class name MD5 MD5 data encrypt algorithm org.apache.shardingsphere.encryption.algorithm.MD5Encrypt AES AES data encrypt algorithm org.apache.shardingsphere.encryption.algorithm.AESEncrypt RC4 RC4 data encrypt algorithm org.apache.shardingsphere.encryption.algorithm.RC4Encrypt SM3 SM3 data encrypt algorithm org.apache.shardingsphere.encryption.algorithm.SM3Encrypt SM4 SM4 data encrypt algorithm org.apache.shardingsphere.encryption.algorithm.SM4Encrypt </description>
</item>
<item>
<title>Shadow DB</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/shadow/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/shadow/</guid>
<description>ShadowAlgorithm Fully-qualified class name org.apache.shardingsphere.shadow.spi.ShadowAlgorithm
Definition Shadow algorithm&amp;rsquo;s definition
Implementation classes Configuration Type Description Fully-qualified class name VALUE_MATCH Match shadow algorithms based on field values org.apache.shardingsphere.shadow.algorithm.shadow.column.ColumnValueMatchedShadowAlgorithm REGEX_MATCH Regular matching shadow algorithm based on field value org.apache.shardingsphere.shadow.algorithm.shadow.column.ColumnRegexMatchedShadowAlgorithm SIMPLE_HINT Simple match shadow algorithm based on Hint org.apache.shardingsphere.shadow.algorithm.shadow.hint.SimpleHintShadowAlgorithm </description>
</item>
<item>
<title>Observability</title>
<link>https://shardingsphere.apache.org/document/current/en/dev-manual/agent/</link>
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
<guid>https://shardingsphere.apache.org/document/current/en/dev-manual/agent/</guid>
<description>PluginBootService Fully-qualified class name org.apache.shardingsphere.agent.spi.boot.PluginBootService
Definition Plugin startup service definition
Implementation classes Configuration Type Description Fully-qualified class name Prometheus Prometheus plugin startup class org.apache.shardingsphere.agent.metrics.prometheus.service.PrometheusPluginBootService Logging Logging plugin startup class org.apache.shardingsphere.agent.plugin.logging.base.service.BaseLoggingPluginBootService Jaeger Jaeger plugin startup class org.apache.shardingsphere.agent.plugin.tracing.jaeger.service.JaegerTracingPluginBootService OpenTelemetry OpenTelemetryTracing plugin startup class org.apache.shardingsphere.agent.plugin.tracing.opentelemetry.service.OpenTelemetryTracingPluginBootService OpenTracing OpenTracing plugin startup class org.apache.shardingsphere.agent.plugin.tracing.opentracing.service.OpenTracingPluginBootService Zipkin Zipkin plugin startup class org.</description>
</item>
</channel>
</rss>