SQL Server 2019 extension (preview)

The SQL Server 2019 extension (preview) provides preview support for new features and tools shipping in support of SQL Server 2019 preview. This includes preview support for SQL Server 2019 big data clusters, an integrated notebook experience, a PolyBase Create External Table wizard, and Azure Resource Explorer.

Install the SQL Server 2019 extension (preview)

To install the SQL Server 2019 extension (preview), download and install the associated .vsix file.

  1. Download the SQL Server 2019 extension (preview) .vsix file to a local directory:

    Platform Download Release date Version
    Windows .vsix November 6, 2018 0.8.0
    macOS .vsix November 6, 2018 0.8.0
    Linux .vsix November 6, 2018 0.8.0
  2. In Azure Data Studio choose Install Extension from VSIX Package from the File menu and select the downloaded .vsix file.

  3. Choose Yes when prompted to confirm installation and wait for the notification that the installation succeeded.

  4. Select Reload to enable the extension (only required the first time you install an extension).

  5. After reloading, the extension will install dependencies. You can see the progress in the Output window, and it could take several minutes.

Release Notes (v0.8.0)

Notebooks:

  • Adding cells before / after existing cells is now supported by clicking the "More Actions" cell button
  • Add New Connection option has been added to the connections in the "Attach To" dropdown
  • A Reinstall Notebook Dependencies command has been added to assist with Python package updates, and solve cases where install was halted partway through by closing the application. This can be run from the command palette (use Ctrl/Cmd+Shift+P and type Reinstall Notebook Dependencies)
  • The PROSE python package has been updated to 1.1.0 and includes a number of bug fixes. Use the Reinstall Notebook Dependencies command to update this package
  • A Clear Output command is now supported by clicking the More Actions cell button
  • Fixed the following customer reported issues:
    • Notebook session could not start on Windows due to PATH issues
    • Notebook could not be started from the root folder of a drive, such as C:\ or D:\
    • #2820 Unable to edit notebooks created from ADS in VS Code
    • Spark UI link now works when running a Spark kernel
    • Renamed "Managed Packages" to "Install Packages"

Create External Data:

  • Error messages are copyable and have been separated into a summary and detailed view for easier
  • Improved UI layout and significantly improved reliability and error handling
  • Fixed the following customer reported issues:
    • Tables with invalid column mappings are shown as disabled and a warning explains the error

Release Notes (v0.7.2)

  • Azure Resource Explorer is now built into Azure Data Studio and has been removed from this extension. Thank you for your feedback on this!
  • Improved performance of notebooks with many Markdown cells.
  • Auto-size code cells in Notebook. This still has a minimum size based on the cell toolbar.
  • Notify user when installing Notebook dependencies. On Windows in particular this can take a long time, so notifications are now shown in the Tasks view.
  • Support reinstalling Notebook dependencies. This is useful if the user previously closed Azure Data Studio partway through installation.
  • Support canceling cell execution in Notebook.
  • Improved reliability when using Create External Data wizard, specifically when connection errors occur.
  • Block use of Create External Data wizard if PolyBase is not enabled or running in the target server.
  • Spelling and naming fixes related to SQL Server 2019 and Create External Data.
  • Removed a large number of errors from the Azure Data Studio debug console.

SQL Server 2019 Big Data Cluster support

  • Click Add Connection in Object Explorer and choose SQL Server big data cluster as the connection type.

    Tip

    If you do not see the SQL Server big data cluster connection type, restart Azure Data Studio.

  • Enter the host name or IP address of the cluster endpoint plus the username & password used to connect.

  • Optionally, include a friendly display name in the Name field.
  • Click Connect and you can then launch common tasks from the Dashboard, browse HDFS in Object Explorer, and run in-context tasks from there.
  • To submit a Spark job against the cluster, right-click on the server node in Object Explorer and choose Submit Spark Job to bring up the submission dialog.
  • To open a Notebook, see the next section.

For details, see Big Data Clusters.

Azure Data Studio Notebooks

  • Open a notebook in one of the following ways:
    • Open a new notebook from the Command Palette.
    • Open the HDFS Object Explorer tree for a SQL Server 2019 big data cluster and either:
      • Right click on the server node and choose New Jupyter Notebook.
      • Right click on a CSV file, and choose Analyze in Notebook.
    • Open an existing .ipynb file from the File menu or file explorer (.ipynb files must be upgraded to version 4 or higher to load properly)
  • Choose a kernel. For local notebook execution, choose Python 3. For remote execution, choose PySpark or Spark | Scala.
  • Choose a SQL Server big data cluster endpoint to connect to if executing remotely (this is not necessary for local development with Python 3).
  • Add code or markdown cells via the buttons in the notebook header. Remove cells with the trash can icon to the left of each cell.
  • Run cells with the play button for code cells, and toggle markdown editing and preview with the eye icon

PolyBase Create External Table Wizard

  • From a SQL Server 2019 instance the Create External Table Wizard can be opened in three ways:
    • Right click on a server, choose Manage, click on the tab for SQL Server 2019 (Preview), and choose Create External Table.
    • With a SQL Server 2019 instance selected in Object Explorer, bring up Create External Wizard via the Command Palette.
    • Right click on a SQL Server 2019 database in Object Explorer and choose Create External Table.
  • In this version of the extension, external tables may be created to access remote SQL Server and Oracle tables.

    Note

    While the External Table functionality is a SQL 2019 feature, the remote SQL Server may be running an earlier version of SQL Server.

  • Choose whether you are accessing SQL Server or Oracle on the first page of the wizard and continue.

  • You will be prompted to create a Database Master Key if one has not already been created (passwords of insufficient complexity will be blocked).
  • Create a data source connection and named credential for the remote server.
  • Choose which objects to map to your new external table.
  • Choose Generate Script or Create to finish the wizard.
  • After creation of the external table, it immediately appears in the object tree of the database where it was created.

Known Issues

  • If password is not saved when creating a connection, some actions such as submitting Spark Job may not succeed.
  • Existing .ipynb notebooks must be upgraded to version 4 or higher to load contents in the viewer.
  • Running the Reinstall Notebook Dependencies command may show 2 tasks in the tasks view, one of which fails. This does not cause installation to fail
  • Choosing Add New Connection in a Notebook and clicking cancel will cause Select Connection to be shown, even if you were already connected.