configuration.yaml Studio configuration file

dse.yaml

The location of the dse.yaml file depends on the type of installation:

Package installations	/etc/dse/dse.yaml
Tarball installations	`installation_location`/resources/dse/conf/dse.yaml

The 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 Studio-specific timeout is applied. Instead, 
# use the DSE server timeouts that are configured in dse.yaml.
# Unit: milliseconds
executionTimeoutMs: 0

# Options to configure the Studio web server.
server:
 httpPort: 9091
 # WARNING: Changing the setting from the default (localhost) can pose a security risk as other
 # users on external machines can gain access to notebooks and the DSE clusters those 
 # notebooks are connected to. Studio is designed to be used as a desktop application. 
 # Distributed deployment introduces potential security risks.
 # See http://docs.datastax.com/en/latest-studio/studio/reference/configuration.html for documentation.
 httpBindAddress: localhost

# Studio logging options.
logging:
 fileName: studio.log
 maxLogFileSize: 250 MB
 maxFiles: 10
 directory: ./logs
 # Spark SQL log level
 # 0: Disable all logging
 # 1: Log severe error events that cause the driver to stop
 # 2: Log errors that may allow driver to continue
 # 3: Log events that might results in an error
 # 4: Log general driver progress information
 # 5: Log detailed driver debug information
 # 6: Log all driver activity
 sparkSQLLogLevel: 0

# The path to the local file system where user data is stored.
userData:
  # Defaults to .datastax_studio folder in your home directory, such as  ~/.datastax_studio
  # Set to a non-null value to override.
  baseDirectory: null

  # Time interval between revision saves when only minor changes are made. 
  # For example, revision cell code and settings changes. Major changes, such as executing a cell 
  # and getting a new result, always create a revision history unless the result is identical 
  # to the prior values.
  historySaveFrequencyInSeconds: 300
  # Directory to store notebooks revisions that can be restored.
  historyDirectory: history
  # Enable Gzip compression of history files.
  compressHistoryFiles: true
  # Enable pruning of history revisions. When there are more than "minHistoryRevisionsToKeep"
  # history revisions, revisions older than "maxDaysOfHistoryToKeep" days are deleted.
  pruneRevisionHistoryEnabled: true
  # Maximum number of days to retain history revisions.
  maxDaysOfHistoryToKeep: 30
  # Minimum number of revisions to retain before pruning by date is enforced.
  minHistoryRevisionsToKeep: 25

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.

Studio web 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.

Logging 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.
sparkSQLLogLevel: Spark SQL log level. Default: 0

User data

The path to the local file system where user data is stored.

baseDirectory: Defaults to .datastax_studio folder in your home directory, such as ~/.datastax_studio. Set to a non-null value to override. Default: null
historySaveFrequencyInSeconds: Time interval between revision saves when only minor changes are made. For example, revision cell code and settings changes. Major changes, such as executing a cell and getting a new result, always create a revision history unless the result is identical to the prior values. Default: 300
historyDirectory: Directory to store notebooks revisions that can be restored. Default: ~/.datastax_studio/history
compressHistoryFiles: Enable Gzip compression of history files. Default: true
pruneRevisionHistoryEnabled: Enable pruning of history revisions. When there are more than minHistoryRevisionsToKeep history revisions, revisions older than maxDaysOfHistoryToKeep days are deleted. Default: true
maxDaysOfHistoryToKeep: Maximum number of days to retain history revisions. Default: 30
minHistoryRevisionsToKeep: Minimum number of revisions to retain before pruning by date is enforced. Default: 25