This is an automated email from the ASF dual-hosted git repository.
jin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph-doc.git
The following commit(s) were added to refs/heads/master by this push:
new c8440156 fix: ik jar need downlaod by user due to license problem (#191)
c8440156 is described below
commit c8440156c1210ec91e463130b0ba6f4ae5032bb2
Author: vaughn <va...@zoom.us>
AuthorDate: Wed Feb 8 20:56:09 2023 +0800
fix: ik jar need downlaod by user due to license problem (#191)
* fix: ik jar need downlaod by user due to license problem
* chore: add download hint for ikanalyzer jar
---
content/cn/docs/config/config-guide.md | 1 +
content/cn/docs/config/config-option.md | 140 ++++++++++++++++----------------
content/en/docs/config/config-guide.md | 1 +
content/en/docs/config/config-option.md | 2 +-
dist/server/ikanalyzer-2012_u6.jar | Bin 0 -> 1178915 bytes
5 files changed, 73 insertions(+), 71 deletions(-)
diff --git a/content/cn/docs/config/config-guide.md b/content/cn/docs/config/config-guide.md
index 419bc685..d60ebe9d 100644
--- a/content/cn/docs/config/config-guide.md
+++ b/content/cn/docs/config/config-guide.md
@@ -199,6 +199,7 @@ raft.rpc_threads=80
raft.rpc_connect_timeout=5000
raft.rpc_timeout=60000
+# if use 'ikanalyzer', need download jar from 'https://github.com/apache/hugegraph-doc/raw/ik_binary/dist/server/ikanalyzer-2012_u6.jar' to lib directory
search.text_analyzer=jieba
search.text_analyzer_mode=INDEX
diff --git a/content/cn/docs/config/config-option.md b/content/cn/docs/config/config-option.md
index 36570651..f20413b5 100644
--- a/content/cn/docs/config/config-option.md
+++ b/content/cn/docs/config/config-option.md
@@ -57,77 +57,77 @@ weight: 2
基本配置项及后端配置项对应配置文件：{graph-name}.properties，如`hugegraph.properties`
-| config option | default value | description [...]
-|---------------------------------------|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| gremlin.graph | com.baidu.hugegraph.HugeFactory | Gremlin entrance to create graph. [...]
-| backend | rocksdb | The data store type, available values are [memory, rocksdb, cassandra, scylladb, hbase, mysql]. [...]
-| serializer | binary | The serializer for backend store, available values are [text, binary, cassandra, hbase, mysql]. [...]
-| store | hugegraph | The database name like Cassandra Keyspace. [...]
-| store.connection_detect_interval | 600 | The interval in seconds for detecting connections, if the idle time of a connection exceeds this value, detect it and reconnect if needed before using, value 0 means detecting every time. [...]
-| store.graph | g | The graph table name, which store vertex, edge and property. [...]
-| store.schema | m | The schema table name, which store meta data. [...]
-| store.system | s | The system table name, which store system data. [...]
-| schema.illegal_name_regex | .*\s+$|~.* | The regex specified the illegal format for schema name. [...]
-| schema.cache_capacity | 10000 | The max cache size(items) of schema cache. [...]
-| vertex.cache_type | l2 | The type of vertex cache, allowed values are [l1, l2]. [...]
-| vertex.cache_capacity | 10000000 | The max cache size(items) of vertex cache. [...]
-| vertex.cache_expire | 600 | The expire time in seconds of vertex cache. [...]
-| vertex.check_customized_id_exist | false | Whether to check the vertices exist for those using customized id strategy. [...]
-| vertex.default_label | vertex | The default vertex label. [...]
-| vertex.tx_capacity | 10000 | The max size(items) of vertices(uncommitted) in transaction. [...]
-| vertex.check_adjacent_vertex_exist | false | Whether to check the adjacent vertices of edges exist. [...]
-| vertex.lazy_load_adjacent_vertex | true | Whether to lazy load adjacent vertices of edges. [...]
-| vertex.part_edge_commit_size | 5000 | Whether to enable the mode to commit part of edges of vertex, enabled if commit size > 0, 0 means disabled. [...]
-| vertex.encode_primary_key_number | true | Whether to encode number value of primary key in vertex id. [...]
-| vertex.remove_left_index_at_overwrite | false | Whether remove left index at overwrite. [...]
-| edge.cache_type | l2 | The type of edge cache, allowed values are [l1, l2]. [...]
-| edge.cache_capacity | 1000000 | The max cache size(items) of edge cache. [...]
-| edge.cache_expire | 600 | The expiration time in seconds of edge cache. [...]
-| edge.tx_capacity | 10000 | The max size(items) of edges(uncommitted) in transaction. [...]
-| query.page_size | 500 | The size of each page when querying by paging. [...]
-| query.batch_size | 1000 | The size of each batch when querying by batch. [...]
-| query.ignore_invalid_data | true | Whether to ignore invalid data of vertex or edge. [...]
-| query.index_intersect_threshold | 1000 | The maximum number of intermediate results to intersect indexes when querying by multiple single index properties. [...]
-| query.ramtable_edges_capacity | 20000000 | The maximum number of edges in ramtable, include OUT and IN edges. [...]
-| query.ramtable_enable | false | Whether to enable ramtable for query of adjacent edges. [...]
-| query.ramtable_vertices_capacity | 10000000 | The maximum number of vertices in ramtable, generally the largest vertex id is used as capacity. [...]
-| query.optimize_aggregate_by_index | false | Whether to optimize aggregate query(like count) by index. [...]
-| oltp.concurrent_depth | 10 | The min depth to enable concurrent oltp algorithm. [...]
-| oltp.concurrent_threads | 10 | Thread number to concurrently execute oltp algorithm. [...]
-| oltp.collection_type | EC | The implementation type of collections used in oltp algorithm. [...]
-| rate_limit.read | 0 | The max rate(times/s) to execute query of vertices/edges. [...]
-| rate_limit.write | 0 | The max rate(items/s) to add/update/delete vertices/edges. [...]
-| task.wait_timeout | 10 | Timeout in seconds for waiting for the task to complete,such as when truncating or clearing the backend. [...]
-| task.input_size_limit | 16777216 | The job input size limit in bytes. [...]
-| task.result_size_limit | 16777216 | The job result size limit in bytes. [...]
-| task.sync_deletion | false | Whether to delete schema or expired data synchronously. [...]
-| task.ttl_delete_batch | 1 | The batch size used to delete expired data. [...]
-| computer.config | /conf/computer.yaml | The config file path of computer job. [...]
-| search.text_analyzer | ikanalyzer | Choose a text analyzer for searching the vertex/edge properties, available type are [word, ansj, hanlp, smartcn, jieba, jcseg, mmseg4j, ikanalyzer]. [...]
+| config option | default value | description [...]
+|---------------------------------------|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
+| gremlin.graph | com.baidu.hugegraph.HugeFactory | Gremlin entrance to create graph. [...]
+| backend | rocksdb | The data store type, available values are [memory, rocksdb, cassandra, scylladb, hbase, mysql]. [...]
+| serializer | binary | The serializer for backend store, available values are [text, binary, cassandra, hbase, mysql]. [...]
+| store | hugegraph | The database name like Cassandra Keyspace. [...]
+| store.connection_detect_interval | 600 | The interval in seconds for detecting connections, if the idle time of a connection exceeds this value, detect it and reconnect if needed before using, value 0 means detecting every time. [...]
+| store.graph | g | The graph table name, which store vertex, edge and property. [...]
+| store.schema | m | The schema table name, which store meta data. [...]
+| store.system | s | The system table name, which store system data. [...]
+| schema.illegal_name_regex | .*\s+$|~.* | The regex specified the illegal format for schema name. [...]
+| schema.cache_capacity | 10000 | The max cache size(items) of schema cache. [...]
+| vertex.cache_type | l2 | The type of vertex cache, allowed values are [l1, l2]. [...]
+| vertex.cache_capacity | 10000000 | The max cache size(items) of vertex cache. [...]
+| vertex.cache_expire | 600 | The expire time in seconds of vertex cache. [...]
+| vertex.check_customized_id_exist | false | Whether to check the vertices exist for those using customized id strategy. [...]
+| vertex.default_label | vertex | The default vertex label. [...]
+| vertex.tx_capacity | 10000 | The max size(items) of vertices(uncommitted) in transaction. [...]
+| vertex.check_adjacent_vertex_exist | false | Whether to check the adjacent vertices of edges exist. [...]
+| vertex.lazy_load_adjacent_vertex | true | Whether to lazy load adjacent vertices of edges. [...]
+| vertex.part_edge_commit_size | 5000 | Whether to enable the mode to commit part of edges of vertex, enabled if commit size > 0, 0 means disabled. [...]
+| vertex.encode_primary_key_number | true | Whether to encode number value of primary key in vertex id. [...]
+| vertex.remove_left_index_at_overwrite | false | Whether remove left index at overwrite. [...]
+| edge.cache_type | l2 | The type of edge cache, allowed values are [l1, l2]. [...]
+| edge.cache_capacity | 1000000 | The max cache size(items) of edge cache. [...]
+| edge.cache_expire | 600 | The expiration time in seconds of edge cache. [...]
+| edge.tx_capacity | 10000 | The max size(items) of edges(uncommitted) in transaction. [...]
+| query.page_size | 500 | The size of each page when querying by paging. [...]
+| query.batch_size | 1000 | The size of each batch when querying by batch. [...]
+| query.ignore_invalid_data | true | Whether to ignore invalid data of vertex or edge. [...]
+| query.index_intersect_threshold | 1000 | The maximum number of intermediate results to intersect indexes when querying by multiple single index properties. [...]
+| query.ramtable_edges_capacity | 20000000 | The maximum number of edges in ramtable, include OUT and IN edges. [...]
+| query.ramtable_enable | false | Whether to enable ramtable for query of adjacent edges. [...]
+| query.ramtable_vertices_capacity | 10000000 | The maximum number of vertices in ramtable, generally the largest vertex id is used as capacity. [...]
+| query.optimize_aggregate_by_index | false | Whether to optimize aggregate query(like count) by index. [...]
+| oltp.concurrent_depth | 10 | The min depth to enable concurrent oltp algorithm. [...]
+| oltp.concurrent_threads | 10 | Thread number to concurrently execute oltp algorithm. [...]
+| oltp.collection_type | EC | The implementation type of collections used in oltp algorithm. [...]
+| rate_limit.read | 0 | The max rate(times/s) to execute query of vertices/edges. [...]
+| rate_limit.write | 0 | The max rate(items/s) to add/update/delete vertices/edges. [...]
+| task.wait_timeout | 10 | Timeout in seconds for waiting for the task to complete,such as when truncating or clearing the backend. [...]
+| task.input_size_limit | 16777216 | The job input size limit in bytes. [...]
+| task.result_size_limit | 16777216 | The job result size limit in bytes. [...]
+| task.sync_deletion | false | Whether to delete schema or expired data synchronously. [...]
+| task.ttl_delete_batch | 1 | The batch size used to delete expired data. [...]
+| computer.config | /conf/computer.yaml | The config file path of computer job. [...]
+| search.text_analyzer | ikanalyzer | Choose a text analyzer for searching the vertex/edge properties, available type are [word, ansj, hanlp, smartcn, jieba, jcseg, mmseg4j, ikanalyzer]. # if use 'ikanalyzer', need download jar from 'https://github.com/apache/hugegraph-doc/raw/ik_binary/dist/server/ikanalyzer-2012_u6.jar' to lib directory [...]
| search.text_analyzer_mode | smart | Specify the mode for the text analyzer, the available mode of analyzer are {word: [MaximumMatching, ReverseMaximumMatching, MinimumMatching, ReverseMinimumMatching, BidirectionalMaximumMatching, BidirectionalMinimumMatching, BidirectionalMaximumMinimumMatching, FullSegmentation, MinimalWordCount, MaxNgramScore, PureEnglish], ansj: [BaseAnalysis, IndexAnalysis, ToAnalysis, NlpAnalysis], hanlp: [standa [...]
-| snowflake.datecenter_id | 0 | The datacenter id of snowflake id generator. [...]
-| snowflake.force_string | false | Whether to force the snowflake long id to be a string. [...]
-| snowflake.worker_id | 0 | The worker id of snowflake id generator. [...]
-| raft.mode | false | Whether the backend storage works in raft mode. [...]
-| raft.safe_read | false | Whether to use linearly consistent read. [...]
-| raft.use_snapshot | false | Whether to use snapshot. [...]
-| raft.endpoint | 127.0.0.1:8281 | The peerid of current raft node. [...]
-| raft.group_peers | 127.0.0.1:8281,127.0.0.1:8282,127.0.0.1:8283 | The peers of current raft group. [...]
-| raft.path | ./raft-log | The log path of current raft node. [...]
-| raft.use_replicator_pipeline | true | Whether to use replicator line, when turned on it multiple logs can be sent in parallel, and the next log doesn't have to wait for the ack message of the current log to be sent. [...]
-| raft.election_timeout | 10000 | Timeout in milliseconds to launch a round of election. [...]
-| raft.snapshot_interval | 3600 | The interval in seconds to trigger snapshot save. [...]
-| raft.backend_threads | current CPU v-cores | The thread number used to apply task to backend. [...]
-| raft.read_index_threads | 8 | The thread number used to execute reading index. [...]
-| raft.apply_batch | 1 | The apply batch size to trigger disruptor event handler. [...]
-| raft.queue_size | 16384 | The disruptor buffers size for jraft RaftNode, StateMachine and LogManager. [...]
-| raft.queue_publish_timeout | 60 | The timeout in second when publish event into disruptor. [...]
-| raft.rpc_threads | 80 | The rpc threads for jraft RPC layer. [...]
-| raft.rpc_connect_timeout | 5000 | The rpc connect timeout for jraft rpc. [...]
-| raft.rpc_timeout | 60000 | The rpc timeout for jraft rpc. [...]
-| raft.rpc_buf_low_water_mark | 10485760 | The ChannelOutboundBuffer's low water mark of netty, when buffer size less than this size, the method ChannelOutboundBuffer.isWritable() will return true, it means that low downstream pressure or good network. [...]
-| raft.rpc_buf_high_water_mark | 20971520 | The ChannelOutboundBuffer's high water mark of netty, only when buffer size exceed this size, the method ChannelOutboundBuffer.isWritable() will return false, it means that the downstream pressure is too great to process the request or network is very congestion, upstream needs to limit rate at this time. [...]
-| raft.read_strategy | ReadOnlyLeaseBased | The linearizability of read strategy. [...]
+| snowflake.datecenter_id | 0 | The datacenter id of snowflake id generator. [...]
+| snowflake.force_string | false | Whether to force the snowflake long id to be a string. [...]
+| snowflake.worker_id | 0 | The worker id of snowflake id generator. [...]
+| raft.mode | false | Whether the backend storage works in raft mode. [...]
+| raft.safe_read | false | Whether to use linearly consistent read. [...]
+| raft.use_snapshot | false | Whether to use snapshot. [...]
+| raft.endpoint | 127.0.0.1:8281 | The peerid of current raft node. [...]
+| raft.group_peers | 127.0.0.1:8281,127.0.0.1:8282,127.0.0.1:8283 | The peers of current raft group. [...]
+| raft.path | ./raft-log | The log path of current raft node. [...]
+| raft.use_replicator_pipeline | true | Whether to use replicator line, when turned on it multiple logs can be sent in parallel, and the next log doesn't have to wait for the ack message of the current log to be sent. [...]
+| raft.election_timeout | 10000 | Timeout in milliseconds to launch a round of election. [...]
+| raft.snapshot_interval | 3600 | The interval in seconds to trigger snapshot save. [...]
+| raft.backend_threads | current CPU v-cores | The thread number used to apply task to backend. [...]
+| raft.read_index_threads | 8 | The thread number used to execute reading index. [...]
+| raft.apply_batch | 1 | The apply batch size to trigger disruptor event handler. [...]
+| raft.queue_size | 16384 | The disruptor buffers size for jraft RaftNode, StateMachine and LogManager. [...]
+| raft.queue_publish_timeout | 60 | The timeout in second when publish event into disruptor. [...]
+| raft.rpc_threads | 80 | The rpc threads for jraft RPC layer. [...]
+| raft.rpc_connect_timeout | 5000 | The rpc connect timeout for jraft rpc. [...]
+| raft.rpc_timeout | 60000 | The rpc timeout for jraft rpc. [...]
+| raft.rpc_buf_low_water_mark | 10485760 | The ChannelOutboundBuffer's low water mark of netty, when buffer size less than this size, the method ChannelOutboundBuffer.isWritable() will return true, it means that low downstream pressure or good network. [...]
+| raft.rpc_buf_high_water_mark | 20971520 | The ChannelOutboundBuffer's high water mark of netty, only when buffer size exceed this size, the method ChannelOutboundBuffer.isWritable() will return false, it means that the downstream pressure is too great to process the request or network is very congestion, upstream needs to limit rate at this time. [...]
+| raft.read_strategy | ReadOnlyLeaseBased | The linearizability of read strategy. [...]
### RPC server 配置
diff --git a/content/en/docs/config/config-guide.md b/content/en/docs/config/config-guide.md
index 419bc685..d60ebe9d 100644
--- a/content/en/docs/config/config-guide.md
+++ b/content/en/docs/config/config-guide.md
@@ -199,6 +199,7 @@ raft.rpc_threads=80
raft.rpc_connect_timeout=5000
raft.rpc_timeout=60000
+# if use 'ikanalyzer', need download jar from 'https://github.com/apache/hugegraph-doc/raw/ik_binary/dist/server/ikanalyzer-2012_u6.jar' to lib directory
search.text_analyzer=jieba
search.text_analyzer_mode=INDEX
diff --git a/content/en/docs/config/config-option.md b/content/en/docs/config/config-option.md
index ed2253b4..fce4c070 100644
--- a/content/en/docs/config/config-option.md
+++ b/content/en/docs/config/config-option.md
@@ -103,7 +103,7 @@ Basic Config Options and Backend Config Options correspond to configuration file
| task.sync_deletion | false | Whether to delete schema or expired data synchronously. [...]
| task.ttl_delete_batch | 1 | The batch size used to delete expired data. [...]
| computer.config | /conf/computer.yaml | The config file path of computer job. [...]
-| search.text_analyzer | ikanalyzer | Choose a text analyzer for searching the vertex/edge properties, available type are [word, ansj, hanlp, smartcn, jieba, jcseg, mmseg4j, ikanalyzer]. [...]
+| search.text_analyzer | ikanalyzer | Choose a text analyzer for searching the vertex/edge properties, available type are [word, ansj, hanlp, smartcn, jieba, jcseg, mmseg4j, ikanalyzer]. if use 'ikanalyzer', need download jar from 'https://github.com/apache/hugegraph-doc/raw/ik_binary/dist/server/ikanalyzer-2012_u6.jar' to lib directory [...]
| search.text_analyzer_mode | smart | Specify the mode for the text analyzer, the available mode of analyzer are {word: [MaximumMatching, ReverseMaximumMatching, MinimumMatching, ReverseMinimumMatching, BidirectionalMaximumMatching, BidirectionalMinimumMatching, BidirectionalMaximumMinimumMatching, FullSegmentation, MinimalWordCount, MaxNgramScore, PureEnglish], ansj: [BaseAnalysis, IndexAnalysis, ToAnalysis, NlpAnalysis], hanlp: [standa [...]
| snowflake.datacenter_id | 0 | The datacenter id of snowflake id generator. [...]
| snowflake.force_string | false | Whether to force the snowflake long id to be a string. [...]
diff --git a/dist/server/ikanalyzer-2012_u6.jar b/dist/server/ikanalyzer-2012_u6.jar
new file mode 100644
index 00000000..6ca68d80
Binary files /dev/null and b/dist/server/ikanalyzer-2012_u6.jar differ