document/current/en/user-manual/common-config/builtin-algorithm/index.xml - shardingsphere-doc - Git at Google

 <?xml version="1.0" encoding="utf-8" standalone="yes"?>
 <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
   <channel>
     <title>Builtin Algorithm on ShardingSphere</title>
     <link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/</link>
     <description>Recent content in Builtin Algorithm on ShardingSphere</description>
     <generator>Hugo -- gohugo.io</generator>
     <language>en-us</language>

 	<atom:link href="https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/index.xml" rel="self" type="application/rss+xml" />


     <item>
       <title>Metadata Repository</title>
       <link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/metadata-repository/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

       <guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/metadata-repository/</guid>
       <description>Background Apache ShardingSphere provides different metadata persistence methods for different running modes. Users can choose an appropriate way to store metadata while configuring the running mode.
 Parameters File Repository Type: File
 Mode: Standalone
 Attributes:
    Name Type Description Default Value     path String Path for metadata persist .shardingsphere    ZooKeeper Repository Type: ZooKeeper
 Mode: Cluster
 Attributes:
    Name Type Description Default Value     retryIntervalMilliseconds int Milliseconds of retry interval 500   maxRetries int Max retries of client connection 3   timeToLiveSeconds int Seconds of ephemeral data live 60   operationTimeoutMilliseconds int Milliseconds of operation timeout 500   digest String Password of login     Etcd Repository Type: Etcd</description>
     </item>

     <item>
       <title>Sharding Algorithm</title>
       <link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/sharding/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

       <guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/sharding/</guid>
       <description>Background ShardingSphere built-in algorithms provide a variety of sharding algorithms, which can be divided into automatic sharding algorithms, standard sharding algorithms, composite sharding algorithms, and hint sharding algorithms, and can meet the needs of most business scenarios of users.
 Additionally, considering the complexity of business scenarios, the built-in algorithm also provides a way to customize the sharding algorithm. Users can complete complex sharding logic by writing java code.
 Parameters Auto Sharding Algorithm Modulo Sharding Algorithm Type: MOD</description>
     </item>

     <item>
       <title>Key Generate Algorithm</title>
       <link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/keygen/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

       <guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/keygen/</guid>
       <description>Background In traditional database software development, automatic primary key generation is a basic requirement and various databases provide support for this requirement, such as MySQL&amp;rsquo;s self-incrementing keys, Oracle&amp;rsquo;s self-incrementing sequences, etc.
 After data sharding, it is a very tricky problem to generate global unique primary keys from different data nodes. Self-incrementing keys between different actual tables within the same logical table generate duplicate primary keys because they are not mutually perceived.</description>
     </item>

     <item>
       <title>Load Balance Algorithm</title>
       <link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/load-balance/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

       <guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/load-balance/</guid>
       <description>Background ShardingSphere built-in provides a variety of load balancer algorithms, including polling algorithm, random access algorithm and weight access algorithm, which can meet users&amp;rsquo; needs in most business scenarios.
 Moreover, considering the complexity of the business scenario, the built-in algorithm also provides an extension mode. Users can implement the load balancer algorithm they need based on SPI interface.
 Parameters    Type Describe Limitations     ROUND_ROBIN Within the transaction, read query are routed to the primary, and outside the transaction, the round-robin strategy is used to route to the replica    RANDOM Within the transaction, read query are routed to the primary, and outside the transaction, the random strategy is used to route to the replica    WEIGHT Within the transaction, read query are routed to the primary, and outside the transaction, the weight strategy is used to route to the replica Attributes need to be configured, attribute name: ${replica-name}, data type: double, attribute name uses the name of the replica, and the parameter fills in the weight value corresponding to the replica.</description>
     </item>

     <item>
       <title>Encryption Algorithm</title>
       <link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/encrypt/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

       <guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/encrypt/</guid>
       <description>Background Encryption algorithms are the algorithms used by the encryption features of Apache ShardingSphere. A variety of algorithms are built-in to make it easy for users to fully leverage the feature.
 Parameters MD5 Encrypt Algorithm Type: MD5
 Attributes: None
 AES Encrypt Algorithm Type: AES
 Attributes:
    Name DataType Description     aes-key-value String AES KEY    RC4 Encrypt Algorithm Type: RC4
 Attributes:
    Name DataType Description     rc4-key-value String RC4 KEY    SM3 Encrypt Algorithm Type: SM3</description>
     </item>

     <item>
       <title>Shadow Algorithm</title>
       <link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/shadow/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

       <guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/shadow/</guid>
       <description>Background The shadow DB feature carries out shadow measurement to SQL statements executed. Shadow measurement supports two types of algorithms, and users can choose one or a combination of them based on actual business needs.
 Parameters Column-based shadow algorithm Column value matching shadow algorithm Type：VALUE_MATCH
    Attribute Name Data Type Description     column String shadow column   operation String SQL operation type (INSERT, UPDATE, DELETE, SELECT)   value String value matched by shadow column    Column-based Regex matching algorithm Type：REGEX_MATCH</description>
     </item>

     <item>
       <title>SQL Translator</title>
       <link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/sql-translator/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

       <guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/sql-translator/</guid>
       <description>Native SQL translator Type: NATIVE
 Attributes:
 None
 Default SQL translator, does not implement yet.
 JooQ SQL translator Type: JOOQ
 Attributes:
 None
 Because of it need JooQ dependency, ShardingSphere does not include the module, please use below XML to import it by Maven.
 &amp;lt;dependency&amp;gt; &amp;lt;groupId&amp;gt;org.apache.shardingsphere&amp;lt;/groupId&amp;gt; &amp;lt;artifactId&amp;gt;shardingsphere-sql-translator-jooq-provider&amp;lt;/artifactId&amp;gt; &amp;lt;version&amp;gt;${project.version}&amp;lt;/version&amp;gt; &amp;lt;/dependency&amp;gt; </description>
     </item>

   </channel>
 </rss>
	<?xml version="1.0" encoding="utf-8" standalone="yes"?>
	<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
	<channel>
	<title>Builtin Algorithm on ShardingSphere</title>
	<link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/</link>
	<description>Recent content in Builtin Algorithm on ShardingSphere</description>
	<generator>Hugo -- gohugo.io</generator>
	<language>en-us</language>

	<atom:link href="https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/index.xml" rel="self" type="application/rss+xml" />


	<item>
	<title>Metadata Repository</title>
	<link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/metadata-repository/</link>
	<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

	<guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/metadata-repository/</guid>
	<description>Background Apache ShardingSphere provides different metadata persistence methods for different running modes. Users can choose an appropriate way to store metadata while configuring the running mode.
	Parameters File Repository Type: File
	Mode: Standalone
	Attributes:
	Name Type Description Default Value path String Path for metadata persist .shardingsphere ZooKeeper Repository Type: ZooKeeper
	Mode: Cluster
	Attributes:
	Name Type Description Default Value retryIntervalMilliseconds int Milliseconds of retry interval 500 maxRetries int Max retries of client connection 3 timeToLiveSeconds int Seconds of ephemeral data live 60 operationTimeoutMilliseconds int Milliseconds of operation timeout 500 digest String Password of login Etcd Repository Type: Etcd</description>
	</item>

	<item>
	<title>Sharding Algorithm</title>
	<link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/sharding/</link>
	<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

	<guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/sharding/</guid>
	<description>Background ShardingSphere built-in algorithms provide a variety of sharding algorithms, which can be divided into automatic sharding algorithms, standard sharding algorithms, composite sharding algorithms, and hint sharding algorithms, and can meet the needs of most business scenarios of users.
	Additionally, considering the complexity of business scenarios, the built-in algorithm also provides a way to customize the sharding algorithm. Users can complete complex sharding logic by writing java code.
	Parameters Auto Sharding Algorithm Modulo Sharding Algorithm Type: MOD</description>
	</item>

	<item>
	<title>Key Generate Algorithm</title>
	<link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/keygen/</link>
	<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

	<guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/keygen/</guid>
	<description>Background In traditional database software development, automatic primary key generation is a basic requirement and various databases provide support for this requirement, such as MySQL&rsquo;s self-incrementing keys, Oracle&rsquo;s self-incrementing sequences, etc.
	After data sharding, it is a very tricky problem to generate global unique primary keys from different data nodes. Self-incrementing keys between different actual tables within the same logical table generate duplicate primary keys because they are not mutually perceived.</description>
	</item>

	<item>
	<title>Load Balance Algorithm</title>
	<link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/load-balance/</link>
	<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

	<guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/load-balance/</guid>
	<description>Background ShardingSphere built-in provides a variety of load balancer algorithms, including polling algorithm, random access algorithm and weight access algorithm, which can meet users&rsquo; needs in most business scenarios.
	Moreover, considering the complexity of the business scenario, the built-in algorithm also provides an extension mode. Users can implement the load balancer algorithm they need based on SPI interface.
	Parameters Type Describe Limitations ROUND_ROBIN Within the transaction, read query are routed to the primary, and outside the transaction, the round-robin strategy is used to route to the replica RANDOM Within the transaction, read query are routed to the primary, and outside the transaction, the random strategy is used to route to the replica WEIGHT Within the transaction, read query are routed to the primary, and outside the transaction, the weight strategy is used to route to the replica Attributes need to be configured, attribute name: ${replica-name}, data type: double, attribute name uses the name of the replica, and the parameter fills in the weight value corresponding to the replica.</description>
	</item>

	<item>
	<title>Encryption Algorithm</title>
	<link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/encrypt/</link>
	<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

	<guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/encrypt/</guid>
	<description>Background Encryption algorithms are the algorithms used by the encryption features of Apache ShardingSphere. A variety of algorithms are built-in to make it easy for users to fully leverage the feature.
	Parameters MD5 Encrypt Algorithm Type: MD5
	Attributes: None
	AES Encrypt Algorithm Type: AES
	Attributes:
	Name DataType Description aes-key-value String AES KEY RC4 Encrypt Algorithm Type: RC4
	Attributes:
	Name DataType Description rc4-key-value String RC4 KEY SM3 Encrypt Algorithm Type: SM3</description>
	</item>

	<item>
	<title>Shadow Algorithm</title>
	<link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/shadow/</link>
	<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

	<guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/shadow/</guid>
	<description>Background The shadow DB feature carries out shadow measurement to SQL statements executed. Shadow measurement supports two types of algorithms, and users can choose one or a combination of them based on actual business needs.
	Parameters Column-based shadow algorithm Column value matching shadow algorithm Type：VALUE_MATCH
	Attribute Name Data Type Description column String shadow column operation String SQL operation type (INSERT, UPDATE, DELETE, SELECT) value String value matched by shadow column Column-based Regex matching algorithm Type：REGEX_MATCH</description>
	</item>

	<item>
	<title>SQL Translator</title>
	<link>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/sql-translator/</link>
	<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>

	<guid>https://shardingsphere.apache.org/document/current/en/user-manual/common-config/builtin-algorithm/sql-translator/</guid>
	<description>Native SQL translator Type: NATIVE
	Attributes:
	None
	Default SQL translator, does not implement yet.
	JooQ SQL translator Type: JOOQ
	Attributes:
	None
	Because of it need JooQ dependency, ShardingSphere does not include the module, please use below XML to import it by Maven.
	&lt;dependency&gt; &lt;groupId&gt;org.apache.shardingsphere&lt;/groupId&gt; &lt;artifactId&gt;shardingsphere-sql-translator-jooq-provider&lt;/artifactId&gt; &lt;version&gt;${project.version}&lt;/version&gt; &lt;/dependency&gt; </description>
	</item>

	</channel>
	</rss>