Generating the BYOS configuration file

The file is used to connect to a DataStax Enterprise cluster from a Spark cluster. The configuration file contains connection information about the DataStax Enterprise cluster. This file must be generated on a node in the DataStax Enterprise cluster. You can specify an arbitrary name for the generated configuration file. The name is used throughout the documentation to refer to this configuration file.


If you are using Graph OLAP queries with BYOS, increase the max_concurrent_sessions setting in your cluster to 120.


  1. Connect to a node in your DataStax Enterprise cluster.

  2. Generate the file using the dse client-tool command.

    dse client-tool configuration byos-export ~/

    This will generate the file in your home directory. See Connect an external client to a DSE node with dse client-tool for more information on the options for dse client-tool.

What’s next

The file can be copied to a node in the external Spark cluster and used with the Spark shell, as described in Connecting to DataStax Enterprise using the Spark shell on an external Spark cluster.

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000,