On this page

    Microsoft SQL Server

    Microsoft SQL Server is a database server for storing and retrieving data.

    This topic describes how to configure a SQL Server database as a Dremio Cloud source:

    Prerequisites

    Ensure that you have the following details before configuring SQL Server as a source:

    • Hostname or IP address of the database
    • Port
    • Ensure that the database version is SQL Server version 2012 or later.

    Dremio Cloud SQL Server Configuration

    Perform these steps to configure SQL Server as a source:

    1. In the Datasets UI, you can see a truncated list of External Sources at the bottom-left of the page. Click the plus (+) icon to add a source.

      Alternatively, click External Sources. The page displays all sources. Click the Add External Source button at the top-right of that page.

    2. In the Add External Source dialog, click Microsoft SQL Server.

    General

    The General tab contains the required fields to create a SQL Server source.

    Perform these steps in the General tab:

    1. In the General tab, for Name, enter a name.
    2. For Host, enter the SQL Server host name.
    3. For Port, enter the SQL Server port number. The default port is 1433.
    4. (Optional) For Database, enter the SQL Server database name.
    5. (Optional) For Encrypt connection, enable encrypted connections to SQL Server using SSL.
    6. For Authentication, Master Authentication is the default and the only option. Provide the username and password of a master database user with permissions to read required objects:
    • For Username, enter your SQL Server database username.
    • For Password, enter your SQL Server database password.

    Advanced Options

    Click Advanced Options in the sidebar.

    note:

    All advanced options are optional.

    Advanced OptionDescription
    Show only the initial database used for connectingIf selected, hides the other databases that the credential has access to.
    Record fetch sizeNumber of records to fetch at once. Set to 0 (zero) to have Dremio Cloud automatically decide. The default record fetch size is 200.
    Maximum Idle ConnectionsThe total number of connections allowed to be idle at a given time. The default maximum idle connections is 8.
    Connection Idle TimeThe amount of time (in seconds) allowed for a connection to remain idle before the connection is terminated. The default connection idle time is 60 seconds.
    EncryptionVerify Server Certificate is enabled. Add an SSL/TLS server certificate distinguished name in the text box.
    Connection PropertiesCustom key value pairs for the connection relevant to the source. To add a connection property, click Add property and add the property name and value.

    Metadata

    You can configure settings to refresh metadata and handle datasets. Click Metadata in the sidebar.

    You can configure Dataset Handling and Metadata Refresh parameters.

    Dataset Handling

    These are the Dataset Handling parameters.

    note:

    All Dataset Handling parameters are optional.

    ParameterDescription
    Remove dataset definitions if underlying data is unavailableBy default, Dremio Cloud removes dataset definitions if underlying data is unavailable. Useful when files are temporarily deleted and added back in the same location with new sets of files.
    Metadata Refresh

    These are the Metadata Refresh parameters:

    • Dataset Discovery: The refresh interval for fetching top-level source object names such as databases and tables. Set the time interval using this parameter.

      ParameterDescription
      (Optional) Fetch everyYou can choose to set the frequency to fetch object names in minutes, hours, days, or weeks. The default frequency to fetch object names is 1 hour.
    • Dataset Details: The metadata that Dremio Cloud needs for query planning such as information required for fields, types, shards, statistics, and locality. These are the parameters to fetch the dataset information.

    note:

    All Dataset Details parameters are optional.

    ParameterDescription
    Fetch modeYou can choose to fetch only from queried datasets that are set by default. Dremio Cloud updates details for previously queried objects in a source. Fetching from all datasets is deprecated.
    Fetch everyYou can choose to set the frequency to fetch dataset details in minutes, hours, days, or weeks. The default frequency to fetch dataset details is 1 hour.
    Expire afterYou can choose to set the expiry time of dataset details in minutes, hours, days, or weeks. The default expiry time of dataset details is 3 hours.

    Privileges

    You can grant privileges to specific users or roles.

    1. (Optional) For Privileges, enter the user name or role name that you want to grant access to and click the Add to Privileges button. The added user or role is displayed in the Users table.
    2. (Optional) For the users or roles in the Users table, toggle the green checkmark for each privilege you want to grant to the SQL Server source that is being created.

    Click Save after setting the configuration.

    Editing a SQL Server Source

    To edit a SQL Server source:

    1. In the Datasets UI, click External Sources at the bottom-left of the page. A list of sources is displayed.

    2. Under the Action column, click the Settings (gear) icon for the source you want to edit. From the list of actions, click Edit Details.

      Alternatively, you can click the source and click the Settings (gear) icon of the source.

    3. In the Edit Source dialog, you cannot edit the name. Editing other parameters is optional. For parameters and advanced options, see Dremio Cloud SQL Server Configuration.

    4. Click Save.

    Removing a SQL Server Source

    To remove a SQL Server source, perform these steps:

    1. In the Datasets UI, click External Sources at the bottom-left of the page. A list of sources is displayed.

    2. Under the Action column, click the Settings (gear) icon for the source that you want to remove.

    3. From the list of actions, click Remove Source. Confirm that you want to remove the source.

    warning:

    Removing a source causes all downstream virtual datasets dependent on objects in this source to break.