config
How to configure graph schema.
Synopsis
schema.config().option(arg).[ set(value) | unset(value) | get() | exists() | describe() ]
Schema can be configured per graph using the config()
command. An option
and value can be set()
or unset()
. An option's value can
be retrieved with the get()
command. Whether or not the option is
configured can be discovered with the exists()
command. The
describe()
command returns a value if the option has been set
manually.
Option argument | Setting Example | Description | Default |
---|---|---|---|
allow_scan | true | Setting to allow costly graph scan queries. | true |
schema_mode | Production | Set mode to Production or Development. | Development |
default_property_key_cardinality | multiple | Set the cardinality that will be used by default unless otherwise specified. | single |
Option argument | Setting Example | Description | Default |
---|---|---|---|
evaluation_timeout | PT10S (10 seconds) | Maximum time to wait for a traversal to evaluate - this will override other system level settings for the current TraversalSource. | 0 days |
restrict_lambda | false | Prevent the use of lambdas with this TraversalSource. A particular traversal source can be identified. | true |
type | read-only | Specify type of TraversalSource. A particular traversal source can be identified. | default |
Option | Setting Example | Description | Default |
---|---|---|---|
authenticated_user | test_user | The username to use as the current user for a transaction. | ANONYMOUS_USER |
cache | true | Cache retrievals and data store calls within a transaction in transaction-level caches. This setting provides a restricted type of isolation within a transaction (concurrent modifications in other transactions aren't visible and result sets remain consistent between calls) and can improve performance at the expense of additional memory consumption. | true |
deep_profiling | true | Enable CQL tracing for profile() in queries. Very costly
profiling. |
false |
internal_vertex_verify | true | Set whether a transaction should verify that vertices for internally provided vertex ids (autogenerated vertex ids) actually exist. | false |
external_vertex_verify | false | Set whether a transaction should verify that vertices for externally provided vertex ids (custom vertex ids) actually exist. | true |
logged_batch | true | Use a logged batch when committing changes. This guarantees that all mutations will eventually occur at the expense of performance. | false |
max_mutations | 5000 | The maximum number of vertices, properties and edges (cumulatively) that may be added or removed in a single transaction. | 10000 |
max_profile_events | 5 | The maximum number of profiling events to report for an individual traversal step. Restricting the number of reported events makes output manageable, but can hide important information. | 10 |
read_only | true | Set whether a transaction is read-only. | false |
read_consistency | ALL | Specify the consistency level for read operations of a transaction. | ONE |
single_thread | true | Set whether a transaction is only accessed by a single thread. | false |
thread_bound | true | Set whether a transaction is bound to a particular thread. | false |
transaction_timestamp | The timestamp at which all mutations of this transaction are persisted. | Instant.EPOCH | |
verify_unique | false | Set whether transactions should ensure that uniqueness constraints are enforced. | true |
vertex_cache_size | 4000 | Maximum size of the transaction-level cache of recently-used vertices | 20000l |
vertex_dirty_size | This is a performance hint for write-heavy, performance-sensitive transactional workloads. If set, it should roughly match the median vertices modified per transaction. | 32 | |
write_consistency | ANY | Specify the consistency level for write operations of a transaction | QUORUM |
Description
Configure a graph. Options can be set
, unset
, or
get
(retrieve the value).
Examples
schema.config().option('graph.allow_scan').set('false')
get()
command with the traversal source type
option:schema.config().option('graph.traversal_sources.*.type').get()
resulting in a list of values for the option that have been manually
set:REAL_TIME
ALL
in the
currently aliased
graph.schema.config().option('graph.tx_groups.default.write_consistency').set('ALL')
schema.config().option('graph.tx_groups.default.write_consistency').get()
schema.config().option('graph.tx_groups.default.write_consistency').exists()
This
command will return:true
if the setting has been set to a value,
otherwise it returns false
.schema.config().option('graph.tx_groups.default.deep_profiling').set('TRUE')
external_vertex_verify()
option:schema.config().option('graph.tx_groups.default.external_vertex_verify').set('TRUE')
If this setting is true, then a vertex will not be returned if it doesn't exist. However, if
external_vertex_verify()
is set to false, then a vertex will be returned
even if the vertex does not exist given an id. Applications should ensure that vertices
exist using the exists()
method for expected behavior.describe()
command:schema.config().describe()
resulting in a list of all options that have been manually
set:graph.tx_groups.default.write_consistency: ALL
graph.allow_scan: False
There are some configuration options for which the default (for example, values are not
explicitly set) is determined by using the value of other configuration options. For
instance, if allow_scan
is not explicitly set, the default value is
true
if schema_mode
is set to
Development
, but false
if the
schema_mode
is set to Production
. These configuration
options are not linked to the default settings, leading to potentially misleading
information when using schema.config().get()
to discover the setting value
because the default value is displayed rather than a set value.
restrict_lambda
to FALSE
in order to test lambda
functions (only appropriate for non-production
systems):schema.config().option('graph.traversal_sources.g.restrict_lambda').set('FALSE')
setting | schema mode | scans allowed |
---|---|---|
dse.yaml schema_mode:Production | Production | no |
dse.yaml schema_mode:Development | Development | yes |
graph.schema_mode:Production | Production | no |
graph.schema_mode:Development | Development | no |
graph.allow_scan:true | Production | yes |
graph.allow_scan:true | Development | yes |