Change sqlalchemy.create_engine to singlestoredb.create_engine

singlestore-labs · Jul 24, 2023 · 5be2a78 · 5be2a78
1 parent 8e4faf0
commit 5be2a78
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 11 deletions.
diff --git a/notebooks/getting-started-with-notebooks/notebook.ipynb b/notebooks/getting-started-with-notebooks/notebook.ipynb
@@ -231,7 +231,30 @@
         "import sqlalchemy as sa\n",
         "\n",
         "# Create a SQLAlchemy engine and connect\n",
-        "db_connection = sa.create_engine(connection_url).connect()\n",
+        "db_connection = sa.create_engine(connection_url).connect()"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "id": "515fb529-745f-4005-a704-241dfe65e985",
+      "metadata": {},
+      "source": [
+        "The SingleStoreDB Python package also adds a convenience function for SQLAlchemy connections\n",
+        "without using the `connection_url`. It automatically gets the connection information from \n",
+        "the `SINGLESTOREDB_URL` environment variable."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "id": "16f8f5df-6019-4fbb-9d4e-e1dd389ea7af",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "import singlestoredb as s2\n",
+        "\n",
+        "# Create a SQLAlchemy engine and connect, without having to specify the connection URL\n",
+        "db_connection = s2.create_engine().connect()\n",
         "\n",
         "# Upload the DataFrame\n",
         "df.to_sql('sf_restaurant_scores', con=db_connection, if_exists='append', chunksize=1000)"

diff --git a/notebooks/image-matching-with-sql/notebook.ipynb b/notebooks/image-matching-with-sql/notebook.ipynb
@@ -118,7 +118,7 @@
         "import numpy as np\n",
         "import pandas as pd\n",
         "import requests\n",
-        "import sqlalchemy as sa\n",
+        "import singlestoredb as s2\n",
         "import tensorflow.compat.v1 as tf\n",
         "from botocore import UNSIGNED\n",
         "from botocore.client import Config\n",
@@ -194,7 +194,7 @@
         "                 converters=dict(vector=json_to_numpy_array))\n",
         "\n",
         "# Create database connection\n",
-        "db_connection = sa.create_engine(connection_url).connect()\n",
+        "db_connection = s2.create_engine().connect()\n",
         "\n",
         "# Upload DataFrame\n",
         "df.to_sql('people', con=db_connection, index=False, if_exists='append')"

diff --git a/notebooks/launch-open-source-apps-with-langchain/notebook.ipynb b/notebooks/launch-open-source-apps-with-langchain/notebook.ipynb
@@ -1,7 +1,6 @@
 {
   "cells": [
     {
-      "attachments": {},
       "cell_type": "markdown",
       "id": "e4bb409e",
       "metadata": {},
@@ -105,9 +104,9 @@
       "metadata": {},
       "outputs": [],
       "source": [
-        "from sqlalchemy import *\n",
+        "from singlestoredb import create_engine\n",
         "\n",
-        "db_connection = create_engine(connection_url)"
+        "db_connection = create_engine().connect()"
       ]
     },
     {
@@ -249,7 +248,7 @@
       "name": "python",
       "nbconvert_exporter": "python",
       "pygments_lexer": "ipython3",
-      "version": "3.10.9"
+      "version": "3.11.3"
     }
   },
   "nbformat": 4,

diff --git a/notebooks/movie-recommendation/notebook.ipynb b/notebooks/movie-recommendation/notebook.ipynb
@@ -463,9 +463,9 @@
       "metadata": {},
       "outputs": [],
       "source": [
-        "from sqlalchemy import create_engine\n",
+        "from singlestoredb import create_engine\n",
         "\n",
-        "db_connection = create_engine(connection_url).connect()"
+        "db_connection = create_engine().connect()"
       ]
     },
     {

diff --git a/notebooks/notebook-basics/notebook.ipynb b/notebooks/notebook-basics/notebook.ipynb
@@ -170,6 +170,27 @@
         "db_connection2 = sa.create_engine(connection_url2).connect()"
       ]
     },
+    {
+      "cell_type": "markdown",
+      "id": "082e240d-9480-46a2-a7da-33508423b8e9",
+      "metadata": {},
+      "source": [
+        "In addition, the SingleStoreDB Python package includes a wrapper `create_engine` function that \n",
+        "uses the `SINGLESTOREDB_URL` without having to specify `connection_url`."
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "id": "4ec8e9a0-b45a-4f6f-b3a5-7b51a5a89ed0",
+      "metadata": {},
+      "outputs": [],
+      "source": [
+        "import singlestoredb as s2\n",
+        "\n",
+        "db_connection = s2.create_engine().connect()"
+      ]
+    },
     {
       "cell_type": "markdown",
       "id": "2dbc2854-2396-49e0-ae9f-5e68cc1e316c",

diff --git a/notebooks/semantic-search-with-openai-qa/notebook.ipynb b/notebooks/semantic-search-with-openai-qa/notebook.ipynb
@@ -303,9 +303,9 @@
       "metadata": {},
       "outputs": [],
       "source": [
-        "import sqlalchemy as sa\n",
+        "import singlestoredb as s2\n",
         "\n",
-        "db_connection = sa.create_engine(connection_url).connect()"
+        "db_connection = s2.create_engine().connect()"
       ]
     },
     {