SQL execution features of the JupyterLab SQL extension
You can execute SQL queries against your connected data sources in the SQL extension of JupyterLab. The following sections explain the most common parameters for running SQL queries inside JupyterLab notebooks:
-
Create a simple connection in Create a simple magic command connection string.
-
Save your query results in a pandas DataFrame in Save SQL query results in a pandas DataFrame.
-
Override or add to connection properties defined by your administrator in Override connection properties.
-
Use query parameters to provide dynamic values in SQL queries.
When you run a cell with the %%sm_sql magic command, the SQL extension
engine executes the SQL query in the cell against the data source specified in the magic
command parameters.
To see the details of the magic command parameters and supported formats, run
%%sm_sql?.
Important
To use Snowflake, users of the SageMaker distribution image version 1.6 must install the
Snowflake Python dependency by running the following micromamba install
snowflake-connector-python -c conda-forge command in a terminal of their
JupyterLab application. Restart the JupyterLab server by running
restart-jupyter-server in the terminal after the installation is
complete.
For SageMaker distribution image versions 1.7 and later, the Snowflake dependency is pre-installed. No action is needed.