Superset: Implement suggestions by CodeRabbit

Author: amotl

docs/integrate/superset/sandbox.md

@@ -2,7 +2,7 @@
 # Set up an Apache Superset development sandbox with CrateDB
 
 ## Introduction
-This is a little walkthrough about how to quickly spawn a development sandbox with Apache Superset, in order to work on the CrateDB Python driver with live code reloading.
+This is a little walkthrough about how to quickly spawn a development sandbox with Apache Superset, in order to work on the CrateDB SQLAlchemy dialect with live code reloading.
 
 ## Prerequisites
 You will need Bash, Docker, Git, and Python to be installed on your workstation. All other prerequisites will be installed into your working tree.
@@ -12,12 +12,12 @@ You will need Bash, Docker, Git, and Python to be installed on your workstation.
 ### CrateDB
 
 Start CrateDB using Docker.
-```console
+```shell
 docker run --rm --publish=4200:4200 --publish=5432:5432 --name=cratedb --env CRATE_HEAP_SIZE=1g crate:latest -Cdiscovery.type=single-node
 ```
 
 Create an example table and insert a single record.
-```console
+```shell
 docker run --interactive --rm --network=host crate:latest crash <<EOF
 CREATE TABLE IF NOT EXISTS testdrive (
     ts TIMESTAMP,
@@ -38,7 +38,7 @@ If you need more data to explore, follow [how to load 2.6M records from the NYC
 
 #### Install Apache Superset from source
 You can copy this whole section verbatim into your terminal.
-```console
+```shell
 # Acquire sources.
 git clone https://github.com/apache/superset --depth=1
 cd superset
@@ -49,8 +49,8 @@ source .venv/bin/activate
 pip install -r requirements/local.txt
 
 # Setup Node.js 16 with NPM 7.
-export NODEJS_VERSION=16.15.1
-export NPM_VERSION=7
+export NODEJS_VERSION=20.19.5
+export NPM_VERSION=10
 source /dev/stdin <<<"$(curl -s https://raw.githubusercontent.com/cicerops/supernode/main/supernode)"
 
 # Run provisioning steps for Apache Superset.
@@ -61,21 +61,21 @@ superset init
 
 #### Link the SQLAlchemy dialect for CrateDB
 In order to link the filesystem location of the Python driver into the sandbox environment, install the package in ["editable" mode](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs).
-```console
+```shell
 pip install --editable=/path/to/sqlalchemy-cratedb
 ```
 If you don't have the sources yet, you can obtain them from the Git repository using `git clone https://github.com/crate/sqlalchemy-cratedb`.
 
 #### Start backend
 By using the `--reload` option, changes on the Python code will be automatically picked up.
-```console
+```shell
 # Invoke development web server with code reload machinery.
 FLASK_ENV=development superset run -p 8088 --with-threads --reload --debugger
 ```
 
 #### Build and start frontend
 In another console, but also within the same virtualenv, you will need to build the frontend and run its development web server.
-```console
+```shell
 source .venv/bin/activate
 cd superset-frontend
 npm install
@@ -89,11 +89,11 @@ npm run dev-server
 You should be ready to go. Now,
 
 - navigate to `http://localhost:4200/#!/console` for exploring the CrateDB Admin UI.
-- navigate to `http://localhost:9000/superset/sqllab/` for exploring your data in Apache Superset, log in with admin/admin.
+- navigate to `http://localhost:8088/superset/sqllab/` for exploring your data in Apache Superset, log in with admin/admin.
 
 ### Create a database connection
 For creating a database connection to CrateDB in Apache Superset, you can either use the user interface, or the HTTP API. Those steps will create the connection using the HTTP API, saving a few clicks and keystrokes.
-```console
+```shell
 # Authenticate and acquire a JWT token.
 AUTH_TOKEN=$(http --session=superset http://localhost:8088/api/v1/security/login username=admin password=admin provider=db | jq -r .access_token)
 

docs/integrate/superset/usage.md

@@ -12,7 +12,7 @@ You will need Bash, Docker, and Python to be installed on your workstation. All
 ## Install
 
 Set up a Python environment, and install and configure Apache Superset. You can locate the installation within an arbitrary folder on your workstation, for example `~/dev/cratedb-superset`.
-```console
+```shell
 # Create and activate Python virtualenv.
 python3 -m venv .venv
 source .venv/bin/activate
@@ -22,12 +22,12 @@ pip install apache-superset sqlalchemy-cratedb httpie
 ```
 
 You need to create a `superset_config.py` file, to configure an individual `SECRET_KEY` for your application.
-```console
+```shell
 echo "SECRET_KEY = '$(docker run --rm alpine/openssl rand -base64 42)'" > superset_config.py
 ```
 
 This sequence of commands initializes the metadata database at `~/.superset/superset.db`, and provisions a superuser account.
-```console
+```shell
 # Configure and initialize Apache Superset.
 export FLASK_APP=superset
 export SUPERSET_CONFIG_PATH=superset_config.py
@@ -39,7 +39,7 @@ superset init
 ## Start services
 
 Start CrateDB using Docker.
-```console
+```shell
 docker run --interactive --rm --pull=always \
   --publish=4200:4200 --publish=5432:5432 \
   --name=cratedb \
@@ -48,7 +48,7 @@ docker run --interactive --rm --pull=always \
 ```
 
 Run Superset server.
-```console
+```shell
 superset run --port=9000 --with-threads
 ```
 
@@ -57,7 +57,7 @@ superset run --port=9000 --with-threads
 Import six million records worth of data from the venerable NYC Yellowcab taxi ride dataset. Depending on the speed of the internet connection between the location of your database instance, and AWS S3, where data is loaded from, it may take about one minute of time.
 
 This is a one-shot command using the [crash](https://cratedb.com/docs/crate/crash/) database shell running in a Docker container, which includes a relevant SQL DDL statement to create the database table schema, and a `COPY FROM` statement to import data from a compressed JSON file located on AWS S3.
-```console
+```shell
 docker run --interactive --rm --network=host crate:latest crash <<EOF
 DROP TABLE IF EXISTS yellowcab;
 CREATE TABLE yellowcab (
@@ -112,7 +112,7 @@ In order to work with data in Apache Superset, before being able to create dashb
 Using [Apache Superset's HTTP API](https://superset.apache.org/docs/api), you can automate the provisioning process. The commands outlined below are using [HTTPie](https://httpie.io/docs/cli) for that purpose, saving a few clicks and keystrokes.
 
 **Connect a database instance**
-```console
+```shell
 # Authenticate and acquire a JWT token.
 AUTH_TOKEN=$(http --session=superset http://localhost:9000/api/v1/security/login username=admin password=admin provider=db | jq -r .access_token)
 
@@ -128,7 +128,7 @@ http --session=superset http://localhost:9000/api/v1/database/ \
 ```
 
 **Register a database table**
-```console
+```shell
 # Register database table as dataset.
 http --session=superset http://localhost:9000/api/v1/dataset/ \
   Authorization:"Bearer ${AUTH_TOKEN}" \
@@ -140,6 +140,11 @@ Now, you can navigate to the Superset Web UI for exploring your newly created da
 
 - `http://localhost:9000/explore/?datasource_type=table&datasource_id=1` 
 
+:::{note}
+The command assumes `database=1`, which implies this is the first database
+connection created. If you have already created other databases in your
+Superset instance, this ID might be incorrect.
+:::
 
 ## Clean up
 1. The development web server of Apache Superset can be terminated by hitting `CTRL+C`.