Docs & rules
apache/shardingsphereGitHub
This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works
masterafa90baLast read 48 min ago
Is this yours? Install to manage it
Once installed, Striff checks every pull request.
370 docs
apache/shardingsphereOpen repository
apache/shardingsphere — documented rules
84 of 84 rules, printed October 10, 2026.
| The sentence in your docs | |||
|---|---|---|---|
| Read Oct 9 | Configuration Type MD5, Description Data masking algorithm based on MD5, Fully-qualified class name org.apache.shardingsphere.mask.algorithm.hash.MD5MaskAlgorithm | MD5MaskAlgorithm implements MaskAlgorithm | Holds |
| Read Oct 9 | Configuration Type KEEP_FIRST_N_LAST_M, Description Keep first n last m data masking algorithm, Fully-qualified class name org.apache.shardingsphere.mask.algorithm.cover.KeepFirstNLastMMaskAlgorithm | KeepFirstNLastMMaskAlgorithm implements MaskAlgorithm | Holds |
| Read Oct 9 | Configuration Type KEEP_FROM_X_TO_Y, Description Keep from x to y data masking algorithm, Fully-qualified class name org.apache.shardingsphere.mask.algorithm.cover.KeepFromXToYMaskAlgorithm | KeepFromXToYMaskAlgorithm implements MaskAlgorithm | Holds |
| Read Oct 9 | Configuration Type MASK_FIRST_N_LAST_M, Description Mask first n last m data masking algorithm, Fully-qualified class name org.apache.shardingsphere.mask.algorithm.cover.MaskFirstNLastMMaskAlgorithm | MaskFirstNLastMMaskAlgorithm implements MaskAlgorithm | Holds |
| Read Oct 9 | Configuration Type MASK_FROM_X_TO_Y, Description Mask from x to y data masking algorithm, Fully-qualified class name org.apache.shardingsphere.mask.algorithm.cover.MaskFromXToYMaskAlgorithm | MaskFromXToYMaskAlgorithm implements MaskAlgorithm | Holds |
| Read Oct 9 | Configuration Type MASK_BEFORE_SPECIAL_CHARS, Description Mask before special chars data masking algorithm, Fully-qualified class name org.apache.shardingsphere.mask.algorithm.cover.MaskBeforeSpecialCharsAlgorithm | MaskBeforeSpecialCharsAlgorithm implements MaskAlgorithm | Holds |
| Read Oct 9 | Configuration Type MASK_AFTER_SPECIAL_CHARS, Description Mask after special chars data masking algorithm, Fully-qualified class name org.apache.shardingsphere.mask.algorithm.cover.MaskAfterSpecialCharsAlgorithm | MaskAfterSpecialCharsAlgorithm implements MaskAlgorithm | Holds |
| Read Oct 9 | Configuration Type GENERIC_TABLE_RANDOM_REPLACE, Description Generic table random replace algorithm, Fully-qualified class name org.apache.shardingsphere.mask.algorithm.replace.GenericTableRandomReplaceAlgorithm | GenericTableRandomReplaceAlgorithm implements MaskAlgorithm | Holds |
| Read Oct 9 | 公开的 server capability 契约按 org.apache.shardingsphere.mcp.api.capability.<capability> 组织，ServiceLoader 入口接口是 org.apache.shardingsphere.mcp.api.MCPHandlerProvider。Request context、session、transport、payload 和 exception 是跨 capability 或基础协议契约，不归入 capability 包。 | MCPHandlerProvider is a contract | Holds |
| Read Oct 9 | 只需要 session identity 或当前 transport 的 handler 使用 MCPRequestContext。该接口只暴露 getSessionIdentity() 和 getActiveTransport()。 | MCPRequestContext has a getSessionIdentity method | Holds |
MCPRequestContext has a getActiveTransport method | Holds | ||
| Read Oct 9 | It exposes exactly getSessionIdentity() and getActiveTransport(). | MCPRequestContext has a getSessionIdentity method | Holds |
MCPRequestContext has a getActiveTransport method | Holds | ||
| Read Oct 9 | MCPSessionIdentity contains the opaque session ID together with optional trusted subject, source, and attributes; | MCPSessionIdentity has subject | Holds |
MCPSessionIdentity has source | Holds | ||
MCPSessionIdentity has attributes | Holds | ||
| Read Oct 9 | 配置标识 MOD, 自动分片算法 Y, 详细说明 基于取模的分片算法, 全限定类名 org.apache.shardingsphere.sharding.algorithm.sharding.mod.ModShardingAlgorithm | ModShardingAlgorithm implements ShardingAlgorithm | Holds |
| Read Oct 9 | 配置标识 HASH_MOD, 自动分片算法 Y, 详细说明 基于哈希取模的分片算法, 全限定类名 org.apache.shardingsphere.sharding.algorithm.sharding.mod.HashModShardingAlgorithm | HashModShardingAlgorithm implements ShardingAlgorithm | Holds |
| Read Oct 9 | 配置标识 BOUNDARY_RANGE, 自动分片算法 Y, 详细说明 基于分片边界的范围分片算法, 全限定类名 org.apache.shardingsphere.sharding.algorithm.sharding.range.BoundaryBasedRangeShardingAlgorithm | BoundaryBasedRangeShardingAlgorithm implements ShardingAlgorithm | Holds |
| Read Oct 9 | 配置标识 VOLUME_RANGE, 自动分片算法 Y, 详细说明 基于分片容量的范围分片算法, 全限定类名 org.apache.shardingsphere.sharding.algorithm.sharding.range.VolumeBasedRangeShardingAlgorithm | VolumeBasedRangeShardingAlgorithm implements ShardingAlgorithm | Holds |
| Read Oct 9 | 配置标识 AUTO_INTERVAL, 自动分片算法 Y, 详细说明 基于可变时间范围的分片算法, 全限定类名 org.apache.shardingsphere.sharding.algorithm.sharding.datetime.AutoIntervalShardingAlgorithm | AutoIntervalShardingAlgorithm implements ShardingAlgorithm | Holds |
| Read Oct 9 | 配置标识 INTERVAL, 自动分片算法 N, 详细说明 基于固定时间范围的分片算法, 全限定类名 org.apache.shardingsphere.sharding.algorithm.sharding.datetime.IntervalShardingAlgorithm | IntervalShardingAlgorithm implements ShardingAlgorithm | Holds |
| Read Oct 9 | 配置标识 CLASS_BASED, 自动分片算法 N, 详细说明 基于自定义类的分片算法, 全限定类名 org.apache.shardingsphere.sharding.algorithm.sharding.classbased.ClassBasedShardingAlgorithm | ClassBasedShardingAlgorithm implements ShardingAlgorithm | Holds |
| Read Oct 9 | 配置标识 INLINE, 自动分片算法 N, 详细说明 基于行表达式的分片算法, 全限定类名 org.apache.shardingsphere.sharding.algorithm.sharding.inline.InlineShardingAlgorithm | InlineShardingAlgorithm implements ShardingAlgorithm | Holds |
| Read Oct 9 | 配置标识 COMPLEX_INLINE, 自动分片算法 N, 详细说明 基于行表达式的复合分片算法, 全限定类名 org.apache.shardingsphere.sharding.algorithm.sharding.inline.ComplexInlineShardingAlgorithm | ComplexInlineShardingAlgorithm implements ShardingAlgorithm | Holds |
| Read Oct 9 | 配置标识 HINT_INLINE, 自动分片算法 N, 详细说明 基于行表达式的 Hint 分片算法, 全限定类名 org.apache.shardingsphere.sharding.algorithm.sharding.hint.HintInlineShardingAlgorithm | HintInlineShardingAlgorithm implements ShardingAlgorithm | Holds |
| Read Oct 9 | Name tables (+), DataType Collection<EncryptTableRuleConfiguration>, Description Encrypt table rule configurations | EncryptRuleConfiguration has tables | Holds |
| Read Oct 9 | Name encryptors (+), DataType Map<String, AlgorithmConfiguration>, Description Encrypt algorithm name and configurations | EncryptRuleConfiguration has encryptors | Holds |
| Read Oct 9 | Name name, DataType String, Description Table name | EncryptTableRuleConfiguration has name | Holds |
| Read Oct 9 | Name columns (+), DataType Collection<EncryptColumnRuleConfiguration>, Description Encrypt column rule configurations | EncryptTableRuleConfiguration has columns | Holds |
EncryptTableRuleConfiguration depends on EncryptColumnRuleConfiguration | Holds | ||
| Read Oct 9 | Name name, DataType String, Description Logic column name | EncryptColumnRuleConfiguration has name | Holds |
| Read Oct 9 | Name cipher, DataType EncryptColumnItemRuleConfiguration, Description Cipher column config | EncryptColumnRuleConfiguration has cipher | Holds |
EncryptColumnRuleConfiguration depends on EncryptColumnItemRuleConfiguration | Holds | ||
| Read Oct 9 | Name assistedQuery (?), DataType EncryptColumnItemRuleConfiguration, Description Assisted query column config | EncryptColumnRuleConfiguration has assistedQuery | Holds |
| Read Oct 9 | Name likeQuery (?), DataType EncryptColumnItemRuleConfiguration, Description Like query column config | EncryptColumnRuleConfiguration has likeQuery | Holds |
| Read Oct 9 | Name name, DataType String, Description encrypt column item name | EncryptColumnItemRuleConfiguration has name | Holds |
| Read Oct 9 | Name encryptorName, DataType String, Description encryptor name | EncryptColumnItemRuleConfiguration has encryptorName | Holds |
| Read Oct 9 | Name type, DataType String, Description Encrypt algorithm type | AlgorithmConfiguration has type | Holds |
| Read Oct 9 | Name props, DataType Properties, Description Encrypt algorithm properties | AlgorithmConfiguration has props | Holds |
| Read Oct 9 | Call createDataSource of ShardingSphereDataSourceFactory to create ShardingSphereDataSource. | ShardingSphereDataSourceFactory has createDataSource | Holds |
ShardingSphereDataSourceFactory depends on ShardingSphereDataSource | Holds | ||
| Read Oct 9 | Name tables (+), DataType Collection<ShardingTableRuleConfiguration>, Description Sharding table rules, Default Value - | ShardingRuleConfiguration has tables | Holds |
| Read Oct 9 | Name autoTables (+), DataType Collection<ShardingAutoTableRuleConfiguration>, Description Sharding auto table rules, Default Value - | ShardingRuleConfiguration has autoTables | Holds |
| Read Oct 9 | Name bindingTableGroups ( ), DataType Collection<String>, Description Binding table rules, Default Value Empty | ShardingRuleConfiguration has bindingTableGroups | Holds |
| Read Oct 9 | Name defaultDatabaseShardingStrategy (?), DataType ShardingStrategyConfiguration, Description Default database sharding strategy, Default Value Not sharding | ShardingRuleConfiguration has defaultDatabaseShardingStrategy | Holds |
| Read Oct 9 | Name defaultTableShardingStrategy (?), DataType ShardingStrategyConfiguration, Description Default table sharding strategy, Default Value Not sharding | ShardingRuleConfiguration has defaultTableShardingStrategy | Holds |
| Read Oct 9 | Name defaultKeyGenerateStrategy (?), DataType KeyGenerateStrategyConfiguration, Description Default key generator, Default Value Snowflake | ShardingRuleConfiguration has defaultKeyGenerateStrategy | Holds |
| Read Oct 9 | Name defaultAuditStrategy (?), DataType ShardingAuditStrategyConfiguration, Description Default key auditor, Default Value DML_SHARDING_CONDITIONS | ShardingRuleConfiguration has defaultAuditStrategy | Holds |
| Read Oct 9 | Name defaultShardingColumn (?), DataType String, Description Default sharding column name, Default Value None | ShardingRuleConfiguration has defaultShardingColumn | Holds |
| Read Oct 9 | Name keyGenerateStrategies (+), DataType Map<String, KeyGenerateStrategiesConfiguration>, Description Sharding key generate strategy name and configurations, Default Value None | ShardingRuleConfiguration has keyGenerateStrategies | Holds |
| Read Oct 9 | Name shardingAlgorithms (+), DataType Map<String, AlgorithmConfiguration>, Description Sharding algorithm name and configurations, Default Value None | ShardingRuleConfiguration has shardingAlgorithms | Holds |
| Read Oct 9 | Name keyGenerators (?), DataType Map<String, AlgorithmConfiguration>, Description Key generate algorithm name and configurations, Default Value None | ShardingRuleConfiguration has keyGenerators | Holds |
| Read Oct 9 | Name auditors (?), DataType Map<String, AlgorithmConfiguration>, Description Sharding audit algorithm name and configurations, Default Value None | ShardingRuleConfiguration has auditors | Holds |
| Read Oct 9 | Name logicTable, DataType String, Description Name of sharding logic table, Default Value - | ShardingTableRuleConfiguration has logicTable | Holds |
| Read Oct 9 | Name actualDataNodes (?), DataType String, Description Describe data source names and actual tables, delimiter as point. Multiple data nodes split by comma, support inline expression, Default Value Broadcast table or databases sharding only | ShardingTableRuleConfiguration has actualDataNodes | Holds |
| Read Oct 9 | Name databaseShardingStrategy (?), DataType ShardingStrategyConfiguration, Description Databases sharding strategy, Default Value Use default databases sharding strategy | ShardingTableRuleConfiguration has databaseShardingStrategy | Holds |
| Read Oct 9 | Name tableShardingStrategy (?), DataType ShardingStrategyConfiguration, Description Tables sharding strategy, Default Value Use default tables sharding strategy | ShardingTableRuleConfiguration has tableShardingStrategy | Holds |
| Read Oct 9 | Name auditStrategy (?), DataType ShardingAuditStrategyConfiguration, Description Sharding audit strategy configuration, Default Value Use default auditor | ShardingTableRuleConfiguration has auditStrategy | Holds |
| Read Oct 9 | Name logicTable, DataType String, Description Name of sharding logic table, Default Value - | ShardingAutoTableRuleConfiguration has logicTable | Holds |
| Read Oct 9 | Name actualDataSources (?), DataType String, Description Data source names. Multiple data nodes split by comma, Default Value Use all configured data sources | ShardingAutoTableRuleConfiguration has actualDataSources | Holds |
| Read Oct 9 | Name shardingStrategy (?), DataType ShardingStrategyConfiguration, Description Sharding strategy, Default Value Use default sharding strategy | ShardingAutoTableRuleConfiguration has shardingStrategy | Holds |
| Read Oct 9 | Name shardingColumn, DataType String, Description Sharding column name | StandardShardingStrategyConfiguration has shardingColumn | Holds |
| Read Oct 9 | Name shardingAlgorithmName, DataType String, Description Sharding algorithm name | StandardShardingStrategyConfiguration has shardingAlgorithmName | Holds |
| Read Oct 9 | Name shardingColumns, DataType String, Description Sharding column name, separated by commas | ComplexShardingStrategyConfiguration has shardingColumns | Holds |
| Read Oct 9 | Name shardingAlgorithmName, DataType String, Description Sharding algorithm name | ComplexShardingStrategyConfiguration has shardingAlgorithmName | Holds |
| Read Oct 9 | Name shardingAlgorithmName, DataType String, Description Sharding algorithm name | HintShardingStrategyConfiguration has shardingAlgorithmName | Holds |
| Read Oct 9 | Name column, DataType String, Description Column name of key generate | KeyGenerateStrategyConfiguration has column | Holds |
| Read Oct 9 | Name keyGeneratorName, DataType String, Description key generate algorithm name | KeyGenerateStrategyConfiguration has keyGeneratorName | Holds |
| Read Oct 9 | Name keyGeneratorName, DataType String, Description Key generate algorithm name | ColumnKeyGenerateStrategiesRuleConfiguration has keyGeneratorName | Holds |
| Read Oct 9 | Name logicTable, DataType String, Description Logic table name | ColumnKeyGenerateStrategiesRuleConfiguration has logicTable | Holds |
| Read Oct 9 | Name keyGenerateColumn, DataType String, Description Column name of key generate | ColumnKeyGenerateStrategiesRuleConfiguration has keyGenerateColumn | Holds |
| Read Oct 9 | Name keyGeneratorName, DataType String, Description Key generate algorithm name | SequenceKeyGenerateStrategiesRuleConfiguration has keyGeneratorName | Holds |
| Read Oct 9 | Name keyGenerateSequence, DataType String, Description Sequence name | SequenceKeyGenerateStrategiesRuleConfiguration has keyGenerateSequence | Holds |
| Read Oct 9 | Name auditorNames, DataType Collection<String>, Description Sharding audit algorithm name | ShardingAuditStrategyConfiguration has auditorNames | Holds |
| Read Oct 9 | Name allowHintDisable, DataType Boolean, Description Enable or disable sharding audit hint | ShardingAuditStrategyConfiguration has allowHintDisable | Holds |
| Read Oct 9 | Method Name connect(Consumer<List<Record>> dataConsumer, ExceptionHandler exceptionHandler, ServerErrorResultHandler errorResultHandler), Return Value void, Description Connect with the server, when connecting, you need to specify 1 Data consumption processing function 2 Exception handling logic during consumption 3 Server error exception handling function | CDCClient has a connect method | Holds |
| Read Oct 9 | Method Name login(CDCLoginParameter parameter), Return Value void, Description CDC login, parameters username username password password | CDCClient has a login method | Holds |
| Read Oct 9 | Method Name startStreaming(StartStreamingParameter parameter), Return Value String, Description Start CDC subscription and return the streaming ID StartStreamingParameter parameters database logical database name schemaTables subscribed table name full whether to subscribe to full data | CDCClient has a startStreaming method | Holds |
| Read Oct 9 | Method Name restartStreaming(String streamingId), Return Value void, Description Restart subscription | CDCClient has a restartStreaming method | Holds |
| Read Oct 9 | Method Name stopStreaming(String streamingId), Return Value void, Description Stop subscription | CDCClient has a stopStreaming method | Holds |
| Read Oct 9 | Method Name dropStreaming(String streamingId), Return Value void, Description Delete subscription | CDCClient has a dropStreaming method | Holds |
| Read Oct 9 | Method Name await(), Return Value void, Description Block the CDC thread and wait for the channel to close | CDCClient has an await method | Holds |
| Read Oct 9 | Method Name close(), Return Value void, Description Close the channel, the process ends | CDCClient has a close method | Holds |
84 rules from 7 docs
See these where the change is. The browser extension puts a pull request's doc findings, and a diagram of what it changed, on the GitHub page itself, so the code and what your docs say about it are side by side.