Basic configuration options in DataStax Studio
The primary configuration file for Studio is dse-studio-install-dir/configuration.yaml
.
A sample configuration file in XML format:
# Maximum number of items returned per cell execution. Additional items will be truncated.
# Unit: count / number of items
resultSizeLimit: 1000
# Maximum size of a cell result. If a cell result exceeds this size then the cell execution will fail.
# Unit: bytes
maxResultSizeBytes: 524288
# Cell execution timeout. A value of 0 indicates no timeout and will depend on the DSE server timeouts configured in dse.yaml.
# Unit: miliseconds
executionTimeoutMs: 0
# TraversalSource mapping for real-time and analytic execution engines. These values correspond to the traversal sources
# configured in dse.yaml.
# Unit: string
traversalSources:
realTimeTraversalSource: g
analyticTraversalSource: a
# This refers to the datastax-studio server
server:
httpPort: 9091
# WARNING!!! Changing this setting from the default(localhost) could pose a security risk as other users on external machines could then
# gain access to notebooks and the clusters those are connected to.
# Studio is designed to be used as a desktop application, but if deploying centrally you should be aware of the potential security risks.
# Please visit http://docs.datastax.com/en/latest-studio/studio/reference/configuration.html for information on configuration
httpBindAddress: localhost
logging:
fileName: studio.log
maxLogFileSize: 250 MB
maxFiles: 10
directory: ./logs
# User data, where we store data specific to a user
# in the application. For the short-term this is the file system, which
# is why we need to explicitly configure a location
userData:
# defaults to a .datastax_studio folder in your home directory, such as ~/.datastax_studio
# set to a non-null value to override
baseDirectory: null
Cell options
resultSizeLimit
-
Maximum number of items returned per cell execution. Additional items will be truncated. Default: 1000.
maxResultSizeBytes
-
Maximum size of a cell result. If a cell result exceeds this size then the cell execution will fail. Default: 10485760.
executionTimeoutMs
-
Cell execution timeout in milliseconds. A value of 0 indicates no timeout override. Uses the DSE server timeouts configured in the
dse.yaml
file. Default: 0.
traversalSources
Traversal source mapping for real-time and analytic execution engines.
These values correspond to the traversal sources configured in the dse.yaml
file.
realTimeTraversalSource
-
Traversal source mapping for real-time execution engine. Default: g
analyticTraversalSource
-
Traversal source mapping for analytic execution engine. Default: a.
Server
httpPort
-
The port on which the Studio server is running. Default: 9091
httpBindAddress
-
The IP address to which the Studio server is bound. Default: 127.0.0.1.
In Studio version 1.0.0, if you change either of these options, you must also change the corresponding |
Logging
Logging-related options:
fileName
-
Name of the log file. Default: studio.log.
maxLogFileSize
-
Default: 250 MB.
maxFiles
-
Maximum number of log files. Default: 10.
directory
-
Path of the directory in which log files are stored. Default:
./log
.
User data
Directories where user data is stored relative to the baseDirectory
:
baseDirectory
-
Default:
~/.datastax_studio
connectionsDirectory
-
userdata/connections