Send Feedback
Skip to content

Workbooks

This page explains how to create, configure, and use Workbooks in the kdb Visual Studio Code Extension.

Workbooks provide an interactive environment for developing q and Python code within kdb Insights Enterprise. They are similar to source files, and offer options for associating code with connections, managing execution targets, and maintaining state across runs.

Workbooks support:

  • q Workbooks (.kdb.q)
  • Python Workbooks (.kdb.py)

Both q and Python Workbooks can execute against Scratchpad or any available DAP in kdb Insights.

Key features

Workbooks include the following key features:

  • Are listed in the WORKBOOKS view in the primary sidebar
  • Can be associated with a connection
  • Support the .kdb.q., kdb.py extensions
  • Are stored in a .kx folder at the root of your open folder
  • You can have multiple Workbooks running against different connections at the same time

Create a Workbook

To create a Workbook, either create a .kdb.q or .kdb.py file manually in the EXPLORER, or use the WORKBOOKS panel in the sidebar to quickly add one. Workbooks are listed in the WORKBOOKS view for convenient access.

Create a Workbook using the WORKBOOKS panel and run code against a specific connection, as follows:

  1. Ensure you have at least one folder open in VS Code.

  2. In the WORKBOOKS view in the primary sidebar, click the + to create either a New q workbook or New Python workbook.

    new workbook

Run code in a Workbook

To run either q or Python code in a Workbook:

  1. Write the code you wish to execute.

  2. Run the code. To run all the code in the file you can use one of the following methods:

    1. Select Run from the upper right of the editor. Using the dropdown next to the button you can choose any of the KX: menu items to run some, or all of the code in the workbook. play dropdown

    2. Right-click and choose KX: Execute Entire File from the menu.

  3. If you have not yet chosen a connection to associate with the workbook, you are asked to choose a connection before you execute the code.

    choose connection

  4. The results populate the kdb results window if it is active; otherwise the output window is populated.

Manage Workbook connections

When you save a workbook file, the code and the connection details are stored. The workbook icon is green when its associated connection is active, and grey when the connection is disconnected or no connection is associated.

You can change the connection associated with a workbook at any time by clicking on the connection from above the first line of code in the workbook file.

change connection

Next steps