| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with this |
| * work for additional information regarding copyright ownership. The ASF |
| * licenses this file to You under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| * License for the specific language governing permissions and limitations |
| * under the License. |
| */ |
| |
| package org.apache.hugegraph.config; |
| |
| import static org.apache.hugegraph.backend.tx.GraphTransaction.COMMIT_BATCH; |
| import static org.apache.hugegraph.config.OptionChecker.allowValues; |
| import static org.apache.hugegraph.config.OptionChecker.disallowEmpty; |
| import static org.apache.hugegraph.config.OptionChecker.positiveInt; |
| import static org.apache.hugegraph.config.OptionChecker.rangeInt; |
| |
| import org.apache.hugegraph.backend.query.Query; |
| import org.apache.hugegraph.type.define.CollectionType; |
| import org.apache.hugegraph.util.Bytes; |
| |
| public class CoreOptions extends OptionHolder { |
| |
| public static final int CPUS = Runtime.getRuntime().availableProcessors(); |
| |
| private CoreOptions() { |
| super(); |
| } |
| |
| private static volatile CoreOptions instance; |
| |
| public static synchronized CoreOptions instance() { |
| if (instance == null) { |
| instance = new CoreOptions(); |
| // Should initialize all static members first, then register. |
| instance.registerOptions(); |
| } |
| return instance; |
| } |
| |
| public static final ConfigOption<String> GREMLIN_GRAPH = |
| new ConfigOption<>( |
| "gremlin.graph", |
| "Gremlin entrance to create graph.", |
| disallowEmpty(), |
| "org.apache.hugegraph.HugeFactory" |
| ); |
| |
| public static final ConfigOption<String> BACKEND = |
| new ConfigOption<>( |
| "backend", |
| "The data store type.", |
| disallowEmpty(), |
| "memory" |
| ); |
| |
| public static final ConfigOption<String> STORE = |
| new ConfigOption<>( |
| "store", |
| "The database name like Cassandra Keyspace.", |
| disallowEmpty(), |
| "hugegraph" |
| ); |
| |
| public static final ConfigOption<String> STORE_GRAPH = |
| new ConfigOption<>( |
| "store.graph", |
| "The graph table name, which store vertex, edge and property.", |
| disallowEmpty(), |
| "g" |
| ); |
| |
| public static final ConfigOption<String> SERIALIZER = |
| new ConfigOption<>( |
| "serializer", |
| "The serializer for backend store, like: text/binary/cassandra.", |
| disallowEmpty(), |
| "text" |
| ); |
| |
| public static final ConfigOption<Boolean> RAFT_MODE = |
| new ConfigOption<>( |
| "raft.mode", |
| "Whether the backend storage works in raft mode.", |
| disallowEmpty(), |
| false |
| ); |
| |
| public static final ConfigOption<Boolean> RAFT_SAFE_READ = |
| new ConfigOption<>( |
| "raft.safe_read", |
| "Whether to use linearly consistent read.", |
| disallowEmpty(), |
| false |
| ); |
| |
| public static final ConfigOption<String> RAFT_PATH = |
| new ConfigOption<>( |
| "raft.path", |
| "The log path of current raft node.", |
| disallowEmpty(), |
| "./raftlog" |
| ); |
| |
| public static final ConfigOption<Boolean> RAFT_REPLICATOR_PIPELINE = |
| new ConfigOption<>( |
| "raft.use_replicator_pipeline", |
| "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.", |
| disallowEmpty(), |
| true |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_ELECTION_TIMEOUT = |
| new ConfigOption<>( |
| "raft.election_timeout", |
| "Timeout in milliseconds to launch a round of election.", |
| rangeInt(0, Integer.MAX_VALUE), |
| 10000 |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_SNAPSHOT_INTERVAL = |
| new ConfigOption<>( |
| "raft.snapshot_interval", |
| "The interval in seconds to trigger snapshot save.", |
| rangeInt(0, Integer.MAX_VALUE), |
| 3600 |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_SNAPSHOT_THREADS = |
| new ConfigOption<>( |
| "raft.snapshot_threads", |
| "The thread number used to do snapshot.", |
| rangeInt(0, Integer.MAX_VALUE), |
| 4 |
| ); |
| |
| public static final ConfigOption<Boolean> RAFT_SNAPSHOT_PARALLEL_COMPRESS = |
| new ConfigOption<>( |
| "raft.snapshot_parallel_compress", |
| "Whether to enable parallel compress.", |
| disallowEmpty(), |
| false |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_SNAPSHOT_COMPRESS_THREADS = |
| new ConfigOption<>( |
| "raft.snapshot_compress_threads", |
| "The thread number used to do snapshot compress.", |
| rangeInt(0, Integer.MAX_VALUE), |
| 4 |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_SNAPSHOT_DECOMPRESS_THREADS = |
| new ConfigOption<>( |
| "raft.snapshot_decompress_threads", |
| "The thread number used to do snapshot decompress.", |
| rangeInt(0, Integer.MAX_VALUE), |
| 4 |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_BACKEND_THREADS = |
| new ConfigOption<>( |
| "raft.backend_threads", |
| "The thread number used to apply task to backend.", |
| rangeInt(0, Integer.MAX_VALUE), |
| CPUS |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_READ_INDEX_THREADS = |
| new ConfigOption<>( |
| "raft.read_index_threads", |
| "The thread number used to execute reading index.", |
| rangeInt(0, Integer.MAX_VALUE), |
| 8 |
| ); |
| |
| public static final ConfigOption<String> RAFT_READ_STRATEGY = |
| new ConfigOption<>( |
| "raft.read_strategy", |
| "The linearizability of read strategy.", |
| allowValues("ReadOnlyLeaseBased", "ReadOnlySafe"), |
| "ReadOnlyLeaseBased" |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_APPLY_BATCH = |
| new ConfigOption<>( |
| "raft.apply_batch", |
| "The apply batch size to trigger disruptor event handler.", |
| positiveInt(), |
| // jraft default value is 32 |
| 1 |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_QUEUE_SIZE = |
| new ConfigOption<>( |
| "raft.queue_size", |
| "The disruptor buffers size for jraft RaftNode, " + |
| "StateMachine and LogManager.", |
| positiveInt(), |
| // jraft default value is 16384 |
| 16384 |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_QUEUE_PUBLISH_TIMEOUT = |
| new ConfigOption<>( |
| "raft.queue_publish_timeout", |
| "The timeout in second when publish event into disruptor.", |
| positiveInt(), |
| // jraft default value is 10(sec) |
| 60 |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_RPC_THREADS = |
| new ConfigOption<>( |
| "raft.rpc_threads", |
| "The rpc threads for jraft RPC layer", |
| positiveInt(), |
| // jraft default value is 80 |
| Math.max(CPUS * 2, 80) |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_RPC_CONNECT_TIMEOUT = |
| new ConfigOption<>( |
| "raft.rpc_connect_timeout", |
| "The rpc connect timeout for jraft rpc.", |
| positiveInt(), |
| // jraft default value is 1000(ms) |
| 5000 |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_RPC_TIMEOUT = |
| new ConfigOption<>( |
| "raft.rpc_timeout", |
| "The general rpc timeout in seconds for jraft rpc.", |
| positiveInt(), |
| // jraft default value is 5s |
| 60 |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_INSTALL_SNAPSHOT_TIMEOUT = |
| new ConfigOption<>( |
| "raft.install_snapshot_rpc_timeout", |
| "The install snapshot rpc timeout in seconds for jraft rpc.", |
| positiveInt(), |
| // jraft default value is 5 minutes |
| 10 * 60 * 60 |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_RPC_BUF_LOW_WATER_MARK = |
| new ConfigOption<>( |
| "raft.rpc_buf_low_water_mark", |
| "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.", |
| positiveInt(), |
| 10 * 1024 * 1024 |
| ); |
| |
| public static final ConfigOption<Integer> RAFT_RPC_BUF_HIGH_WATER_MARK = |
| new ConfigOption<>( |
| "raft.rpc_buf_high_water_mark", |
| "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.", |
| positiveInt(), |
| 20 * 1024 * 1024 |
| ); |
| |
| public static final ConfigOption<Integer> RATE_LIMIT_WRITE = |
| new ConfigOption<>( |
| "rate_limit.write", |
| "The max rate(items/s) to add/update/delete vertices/edges.", |
| rangeInt(0, Integer.MAX_VALUE), |
| 0 |
| ); |
| |
| public static final ConfigOption<Integer> RATE_LIMIT_READ = |
| new ConfigOption<>( |
| "rate_limit.read", |
| "The max rate(times/s) to execute query of vertices/edges.", |
| rangeInt(0, Integer.MAX_VALUE), |
| 0 |
| ); |
| |
| public static final ConfigOption<Long> TASK_WAIT_TIMEOUT = |
| new ConfigOption<>( |
| "task.wait_timeout", |
| "Timeout in seconds for waiting for the task to " + |
| "complete, such as when truncating or clearing the " + |
| "backend.", |
| rangeInt(0L, Long.MAX_VALUE), |
| 10L |
| ); |
| |
| public static final ConfigOption<Long> TASK_INPUT_SIZE_LIMIT = |
| new ConfigOption<>( |
| "task.input_size_limit", |
| "The job input size limit in bytes.", |
| rangeInt(0L, Bytes.GB), |
| 16 * Bytes.MB |
| ); |
| |
| public static final ConfigOption<Long> TASK_RESULT_SIZE_LIMIT = |
| new ConfigOption<>( |
| "task.result_size_limit", |
| "The job result size limit in bytes.", |
| rangeInt(0L, Bytes.GB), |
| 16 * Bytes.MB |
| ); |
| |
| public static final ConfigOption<Integer> TASK_TTL_DELETE_BATCH = |
| new ConfigOption<>( |
| "task.ttl_delete_batch", |
| "The batch size used to delete expired data.", |
| rangeInt(1, 500), |
| 1 |
| ); |
| |
| public static final ConfigOption<Boolean> TASK_SYNC_DELETION = |
| new ConfigOption<>( |
| "task.sync_deletion", |
| "Whether to delete schema or expired data synchronously.", |
| disallowEmpty(), |
| false |
| ); |
| |
| public static final ConfigOption<Long> STORE_CONN_DETECT_INTERVAL = |
| new ConfigOption<>( |
| "store.connection_detect_interval", |
| "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.", |
| rangeInt(0L, Long.MAX_VALUE), |
| 600L |
| ); |
| |
| public static final ConfigOption<String> VERTEX_DEFAULT_LABEL = |
| new ConfigOption<>( |
| "vertex.default_label", |
| "The default vertex label.", |
| disallowEmpty(), |
| "vertex" |
| ); |
| |
| public static final ConfigOption<Boolean> VERTEX_CHECK_CUSTOMIZED_ID_EXIST = |
| new ConfigOption<>( |
| "vertex.check_customized_id_exist", |
| "Whether to check the vertices exist for those using " + |
| "customized id strategy.", |
| disallowEmpty(), |
| false |
| ); |
| |
| public static final ConfigOption<Boolean> VERTEX_REMOVE_LEFT_INDEX = |
| new ConfigOption<>( |
| "vertex.remove_left_index_at_overwrite", |
| "Whether remove left index at overwrite.", |
| disallowEmpty(), |
| false |
| ); |
| |
| public static final ConfigOption<Boolean> VERTEX_ADJACENT_VERTEX_EXIST = |
| new ConfigOption<>( |
| "vertex.check_adjacent_vertex_exist", |
| "Whether to check the adjacent vertices of edges exist.", |
| disallowEmpty(), |
| false |
| ); |
| |
| public static final ConfigOption<Boolean> VERTEX_ADJACENT_VERTEX_LAZY = |
| new ConfigOption<>( |
| "vertex.lazy_load_adjacent_vertex", |
| "Whether to lazy load adjacent vertices of edges.", |
| disallowEmpty(), |
| true |
| ); |
| |
| public static final ConfigOption<Integer> VERTEX_PART_EDGE_COMMIT_SIZE = |
| new ConfigOption<>( |
| "vertex.part_edge_commit_size", |
| "Whether to enable the mode to commit part of edges of " + |
| "vertex, enabled if commit size > 0, 0 meas disabled.", |
| rangeInt(0, (int) Query.DEFAULT_CAPACITY), |
| 5000 |
| ); |
| |
| public static final ConfigOption<Boolean> VERTEX_ENCODE_PK_NUMBER = |
| new ConfigOption<>( |
| "vertex.encode_primary_key_number", |
| "Whether to encode number value of primary key " + |
| "in vertex id.", |
| disallowEmpty(), |
| true |
| ); |
| |
| public static final ConfigOption<Integer> VERTEX_TX_CAPACITY = |
| new ConfigOption<>( |
| "vertex.tx_capacity", |
| "The max size(items) of vertices(uncommitted) in " + |
| "transaction.", |
| rangeInt(COMMIT_BATCH, 1000000), |
| 10000 |
| ); |
| |
| public static final ConfigOption<Integer> EDGE_TX_CAPACITY = |
| new ConfigOption<>( |
| "edge.tx_capacity", |
| "The max size(items) of edges(uncommitted) in " + |
| "transaction.", |
| rangeInt(COMMIT_BATCH, 1000000), |
| 10000 |
| ); |
| |
| public static final ConfigOption<Boolean> QUERY_IGNORE_INVALID_DATA = |
| new ConfigOption<>( |
| "query.ignore_invalid_data", |
| "Whether to ignore invalid data of vertex or edge.", |
| disallowEmpty(), |
| true |
| ); |
| |
| public static final ConfigOption<Boolean> QUERY_OPTIMIZE_AGGR_BY_INDEX = |
| new ConfigOption<>( |
| "query.optimize_aggregate_by_index", |
| "Whether to optimize aggregate query(like count) by index.", |
| disallowEmpty(), |
| false |
| ); |
| |
| public static final ConfigOption<Integer> QUERY_BATCH_SIZE = |
| new ConfigOption<>( |
| "query.batch_size", |
| "The size of each batch when querying by batch.", |
| rangeInt(1, (int) Query.DEFAULT_CAPACITY), |
| 1000 |
| ); |
| |
| public static final ConfigOption<Integer> QUERY_PAGE_SIZE = |
| new ConfigOption<>( |
| "query.page_size", |
| "The size of each page when querying by paging.", |
| rangeInt(1, (int) Query.DEFAULT_CAPACITY), |
| 500 |
| ); |
| |
| public static final ConfigOption<Integer> QUERY_INDEX_INTERSECT_THRESHOLD = |
| new ConfigOption<>( |
| "query.index_intersect_threshold", |
| "The maximum number of intermediate results to " + |
| "intersect indexes when querying by multiple single " + |
| "index properties.", |
| rangeInt(1, (int) Query.DEFAULT_CAPACITY), |
| 1000 |
| ); |
| |
| public static final ConfigOption<Boolean> QUERY_RAMTABLE_ENABLE = |
| new ConfigOption<>( |
| "query.ramtable_enable", |
| "Whether to enable ramtable for query of adjacent edges.", |
| disallowEmpty(), |
| false |
| ); |
| |
| public static final ConfigOption<Long> QUERY_RAMTABLE_VERTICES_CAPACITY = |
| new ConfigOption<>( |
| "query.ramtable_vertices_capacity", |
| "The maximum number of vertices in ramtable, " + |
| "generally the largest vertex id is used as capacity.", |
| rangeInt(1L, Integer.MAX_VALUE * 2L), |
| 10000000L |
| ); |
| |
| public static final ConfigOption<Integer> QUERY_RAMTABLE_EDGES_CAPACITY = |
| new ConfigOption<>( |
| "query.ramtable_edges_capacity", |
| "The maximum number of edges in ramtable, " + |
| "include OUT and IN edges.", |
| rangeInt(1, Integer.MAX_VALUE), |
| 20000000 |
| ); |
| |
| /** |
| * The schema name rule: |
| * 1、Not allowed end with spaces |
| * 2、Not allowed start with '~' |
| */ |
| public static final ConfigOption<String> SCHEMA_ILLEGAL_NAME_REGEX = |
| new ConfigOption<>( |
| "schema.illegal_name_regex", |
| "The regex specified the illegal format for schema name.", |
| disallowEmpty(), |
| ".*\\s+$|~.*" |
| ); |
| |
| public static final ConfigOption<Long> SCHEMA_CACHE_CAPACITY = |
| new ConfigOption<>( |
| "schema.cache_capacity", |
| "The max cache size(items) of schema cache.", |
| rangeInt(0L, Long.MAX_VALUE), |
| 10000L |
| ); |
| |
| public static final ConfigOption<String> VERTEX_CACHE_TYPE = |
| new ConfigOption<>( |
| "vertex.cache_type", |
| "The type of vertex cache, allowed values are [l1, l2].", |
| allowValues("l1", "l2"), |
| "l2" |
| ); |
| |
| public static final ConfigOption<Long> VERTEX_CACHE_CAPACITY = |
| new ConfigOption<>( |
| "vertex.cache_capacity", |
| "The max cache size(items) of vertex cache.", |
| rangeInt(0L, Long.MAX_VALUE), |
| (1000 * 1000 * 10L) |
| ); |
| |
| public static final ConfigOption<Integer> VERTEX_CACHE_EXPIRE = |
| new ConfigOption<>( |
| "vertex.cache_expire", |
| "The expiration time in seconds of vertex cache.", |
| rangeInt(0, Integer.MAX_VALUE), |
| (60 * 10) |
| ); |
| |
| public static final ConfigOption<String> EDGE_CACHE_TYPE = |
| new ConfigOption<>( |
| "edge.cache_type", |
| "The type of edge cache, allowed values are [l1, l2].", |
| allowValues("l1", "l2"), |
| "l2" |
| ); |
| |
| public static final ConfigOption<Long> EDGE_CACHE_CAPACITY = |
| new ConfigOption<>( |
| "edge.cache_capacity", |
| "The max cache size(items) of edge cache.", |
| rangeInt(0L, Long.MAX_VALUE), |
| (1000 * 1000 * 1L) |
| ); |
| |
| public static final ConfigOption<Integer> EDGE_CACHE_EXPIRE = |
| new ConfigOption<>( |
| "edge.cache_expire", |
| "The expiration time in seconds of edge cache.", |
| rangeInt(0, Integer.MAX_VALUE), |
| (60 * 10) |
| ); |
| |
| public static final ConfigOption<Long> SNOWFLAKE_WORKER_ID = |
| new ConfigOption<>( |
| "snowflake.worker_id", |
| "The worker id of snowflake id generator.", |
| disallowEmpty(), |
| 0L |
| ); |
| |
| public static final ConfigOption<Long> SNOWFLAKE_DATACENTER_ID = |
| new ConfigOption<>( |
| "snowflake.datacenter_id", |
| "The datacenter id of snowflake id generator.", |
| disallowEmpty(), |
| 0L |
| ); |
| |
| public static final ConfigOption<Boolean> SNOWFLAKE_FORCE_STRING = |
| new ConfigOption<>( |
| "snowflake.force_string", |
| "Whether to force the snowflake long id to be a string.", |
| disallowEmpty(), |
| false |
| ); |
| |
| public static final ConfigOption<String> TEXT_ANALYZER = |
| new ConfigOption<>( |
| "search.text_analyzer", |
| "Choose a text analyzer for searching the " + |
| "vertex/edge properties, available type are " + |
| "[ansj, hanlp, smartcn, jieba, jcseg, " + |
| "mmseg4j, ikanalyzer].", |
| disallowEmpty(), |
| "ikanalyzer" |
| ); |
| |
| public static final ConfigOption<String> TEXT_ANALYZER_MODE = |
| new ConfigOption<>( |
| "search.text_analyzer_mode", |
| "Specify the mode for the text analyzer, " + |
| "the available mode of analyzer are " + |
| "ansj: [BaseAnalysis, IndexAnalysis, ToAnalysis, " + |
| "NlpAnalysis], " + |
| "hanlp: [standard, nlp, index, nShort, shortest, speed], " + |
| "smartcn: [], " + |
| "jieba: [SEARCH, INDEX], " + |
| "jcseg: [Simple, Complex], " + |
| "mmseg4j: [Simple, Complex, MaxWord], " + |
| "ikanalyzer: [smart, max_word]" + |
| "}.", |
| disallowEmpty(), |
| "smart" |
| ); |
| |
| public static final ConfigOption<String> COMPUTER_CONFIG = |
| new ConfigOption<>( |
| "computer.config", |
| "The config file path of computer job.", |
| disallowEmpty(), |
| "./conf/computer.yaml" |
| ); |
| |
| public static final ConfigOption<Integer> OLTP_CONCURRENT_THREADS = |
| new ConfigOption<>( |
| "oltp.concurrent_threads", |
| "Thread number to concurrently execute oltp algorithm.", |
| rangeInt(0, 65535), |
| 10 |
| ); |
| |
| public static final ConfigOption<Integer> OLTP_CONCURRENT_DEPTH = |
| new ConfigOption<>( |
| "oltp.concurrent_depth", |
| "The min depth to enable concurrent oltp algorithm.", |
| rangeInt(0, 65535), |
| 10 |
| ); |
| |
| public static final ConfigConvOption<String, CollectionType> OLTP_COLLECTION_TYPE = |
| new ConfigConvOption<>( |
| "oltp.collection_type", |
| "The implementation type of collections " + |
| "used in oltp algorithm.", |
| allowValues("JCF", "EC", "FU"), |
| CollectionType::valueOf, |
| "EC" |
| ); |
| } |
