Interface IDatabricksSession

  • All Known Implementing Classes:
    DatabricksSession

    public interface IDatabricksSession
    Session interface to represent an open connection to Databricks server.
    • Method Detail

      • getSessionId

        @Nullable
        String getSessionId()
        Get the unique session-Id associated with the session.
        Returns:
        session-Id
      • isOpen

        boolean isOpen()
        Checks if session is open and valid.
        Returns:
        true if session is open
      • getDatabricksClient

        IDatabricksClient getDatabricksClient()
        Returns the client for connecting to Databricks server
        Returns:
        the Databricks client
      • getDatabricksMetadataClient

        IDatabricksMetadataClient getDatabricksMetadataClient()
        Returns the metadata client
        Returns:
        the Databricks metadata client
      • getCatalog

        String getCatalog()
        Returns default catalog associated with the session
        Returns:
        the default catalog
      • getCompressionCodec

        CompressionCodec getCompressionCodec()
        Returns the compression algorithm used on results data
        Returns:
        the compression codec
      • getSchema

        String getSchema()
        Returns default schema associated with the session
        Returns:
        the default schema
      • setCatalog

        void setCatalog​(String catalog)
        Sets the default catalog
        Parameters:
        catalog - the catalog to set
      • setSchema

        void setSchema​(String schema)
        Sets the default schema
        Parameters:
        schema - the schema to set
      • getSessionConfigs

        Map<String,​String> getSessionConfigs()
        Returns the session configs
        Returns:
        map of session configuration key-value pairs
      • setSessionConfig

        void setSessionConfig​(String name,
                              String value)
        Sets the session config
        Parameters:
        name - the configuration name
        value - the configuration value
      • getClientInfoProperties

        Map<String,​String> getClientInfoProperties()
        Returns the client info properties
      • setClientInfoProperty

        void setClientInfoProperty​(String name,
                                   String value)
        Sets the client info property
      • setEmptyMetadataClient

        void setEmptyMetadataClient()
      • forceClose

        void forceClose()
      • setAutoCommit

        void setAutoCommit​(boolean autoCommit)
        Sets the auto-commit mode for this session.
        Parameters:
        autoCommit - true to enable auto-commit; false to disable
      • getAutoCommit

        boolean getAutoCommit()
        Retrieves the current auto-commit mode for this session.
        Returns:
        true if auto-commit mode is enabled; false otherwise