singlestoredb 1.16.1__py3-none-any.whl

singlestoredb/server/free_tier.py

@@ -0,0 +1,267 @@
+#!/usr/bin/env python
+"""Utilities for running SingleStoreDB in the free tier."""
+from __future__ import annotations
+
+import atexit
+import os
+import platform
+import signal
+import subprocess
+import urllib.parse
+from types import TracebackType
+from typing import Any
+from typing import Dict
+from typing import List
+from typing import Optional
+from typing import Type
+
+import requests
+
+from .. import connect
+from ..connection import Connection
+
+try:
+    import pymongo
+    has_pymongo = True
+except ImportError:
+    has_pymongo = False
+
+
+class SingleStoreDB:
+    """
+    Manager for SingleStoreDB server running in Docker.
+
+    Parameters
+    -----------
+    global_vars : dict, optional
+        Global variables to set in the SingleStoreDB server.
+    init_sql : str, optional
+        Path to an SQL file to run on startup.
+
+    """
+
+    user: str
+    password: str
+    kai_enabled: bool
+    server_port: int
+    data_api_port: int
+    kai_port: Optional[int]
+
+    def __init__(self) -> None:
+        r = requests.get('https://shell.singlestore.com/api/session')
+
+        self._cookies = r.cookies.get_dict()
+
+        if 'userSessionID' in self._cookies:
+            self._session_id = self._cookies['userSessionID']
+        else:
+            self._session_id = ''
+
+        d = r.json()
+
+        self._connected = True
+        self.kai_enabled = True
+        self.kai_port = 27017
+        self.server_port = 3333
+        self.data_api_port = 443
+        self.user = d['user']
+        self.password = d['password']
+        self._database = d['databaseName']
+        self._endpoint = d['endpoint']
+        self._workspace_id = d['workspaceID']
+
+        self._saved_server_urls: Dict[str, Optional[str]] = {}
+
+        # Make sure container gets cleaned up at exit
+        atexit.register(self.stop)
+        signal.signal(signal.SIGINT, self.stop)
+        signal.signal(signal.SIGTERM, self.stop)
+
+        self._set_server_urls()
+
+    def __str__(self) -> str:
+        return f"SingleStoreDB('{self.connection_url}')"
+
+    def __repr__(self) -> str:
+        return str(self)
+
+    def _set_server_urls(self) -> None:
+        self._saved_server_urls['DATABASE_URL'] = os.environ.get('DATABASE_URL')
+        os.environ['DATABASE_URL'] = self.connection_url
+        self._saved_server_urls['SINGLESTOREDB_URL'] = os.environ.get('SINGLESTOREDB_URL')
+        os.environ['SINGLESTOREDB_URL'] = self.connection_url
+
+    def _restore_server_urls(self) -> None:
+        try:
+            for k, v in self._saved_server_urls.items():
+                if v is None:
+                    del os.environ[k]
+                else:
+                    os.environ[k] = v
+        except KeyError:
+            pass
+
+    def logs(self) -> List[str]:
+        return []
+
+    @property
+    def connection_url(self) -> str:
+        """Connection URL for the SingleStoreDB server."""
+        dbname = f'/{self._database}' if self._database else ''
+        password = urllib.parse.quote_plus(self.password)
+        return f'singlestoredb://{self.user}:{password}@' + \
+               f'{self._endpoint}:{self.server_port}{dbname}'
+
+    @property
+    def http_connection_url(self) -> str:
+        """HTTP Connection URL for the SingleStoreDB server."""
+        dbname = f'/{self._database}' if self._database else ''
+        password = urllib.parse.quote_plus(self.password)
+        return f'singlestoredb+https://{self.user}:{password}@' + \
+               f'{self._endpoint}:{self.data_api_port}{dbname}'
+
+    def connect(
+        self,
+        use_data_api: bool = False,
+        **kwargs: Any,
+    ) -> Connection:
+        """
+        Connect to the SingleStoreDB server.
+
+        Parameters
+        -----------
+        use_data_api : bool, optional
+            Use the Data API for the connection.
+        **kwargs : Any, optional
+            Additional keyword arguments to pass to the connection.
+
+        Returns
+        --------
+        Connection : Connection to the SingleStoreDB server.
+
+        """
+        if use_data_api:
+            return connect(self.http_connection_url, **kwargs)
+        return connect(self.connection_url, **kwargs)
+
+    @property
+    def kai_url(self) -> Optional[str]:
+        """Connection URL for the Kai (MongoDB) server."""
+        if not self.kai_enabled:
+            return None
+        password = urllib.parse.quote_plus(self.password)
+        endpoint = self._endpoint.replace('shared-dml', 'shared-mongo')
+        return f'mongodb://{self.user}^{self._database}:{password}@' + \
+               f'{endpoint}:{self.kai_port}/' + \
+               '?authMechanism=PLAIN&tls=true&loadBalanced=true' + \
+               f'&dbName={self._database}'
+
+    def connect_kai(self) -> 'pymongo.MongoClient':
+        """Connect to the Kai (MongoDB) server."""
+        if not self.kai_enabled:
+            raise RuntimeError('kai is not enabled')
+        if not has_pymongo:
+            raise RuntimeError('pymongo is not installed')
+        return pymongo.MongoClient(self.kai_url)
+
+    def open_shell(self) -> None:
+        """Open a shell in the SingleStoreDB server."""
+        if platform.platform().lower().startswith('macos'):
+            subprocess.call(
+                ' '.join([
+                    'osascript', '-e',
+                    'tell app "Terminal" to do script "' +
+                    ' '.join([
+                        'mysql', '-h', self._endpoint,
+                        '-P', str(self.server_port),
+                        '-u', self.user,
+                        f'--password=\'{self.password}\'',
+                        self._database,
+                    ]) +
+                    '"',
+                ]), shell=True,
+            )
+        elif platform.platform().lower().startswith('linux'):
+            subprocess.call(
+                ' '.join([
+                    'gnome-terminal', '--',
+                    'mysql', '-h', self._endpoint,
+                    '-P', str(self.server_port),
+                    '-u', self.user,
+                    f'--password="{self.password}"',
+                    self._database,
+                ]), shell=True,
+            )
+        elif platform.platform().lower().startswith('windows'):
+            subprocess.call(
+                ' '.join([
+                    'start', 'cmd', '/k'
+                    'mysql', '-h', self._endpoint,
+                    '-P', str(self.server_port),
+                    '-u', self.user,
+                    f'--password="{self.password}"',
+                    self._database,
+                ]), shell=True,
+            )
+        else:
+            raise RuntimeError('unsupported platform')
+
+    def open_mongosh(self) -> None:
+        """Open a mongosh in the SingleStoreDB server."""
+        if not self.kai_enabled:
+            raise RuntimeError('kai interface is not enabled')
+        if platform.platform().lower().startswith('macos'):
+            subprocess.call([
+                'osascript', '-e',
+                'tell app "Terminal" to do script "' +
+                ' '.join(['mongosh', str(self.kai_url)]) +
+                '"',
+            ])
+        elif platform.platform().lower().startswith('linux'):
+            subprocess.call([
+                'gnome-terminal', '--',
+                'mongosh', str(self.kai_url),
+            ])
+        elif platform.platform().lower().startswith('windows'):
+            subprocess.call([
+                'start', 'cmd', '/k'
+                'mongosh', str(self.kai_url),
+            ])
+        else:
+            raise RuntimeError('unsupported platform')
+
+    def __enter__(self) -> SingleStoreDB:
+        return self
+
+    def __exit__(
+        self,
+        exc_type: Optional[Type[BaseException]],
+        exc_val: Optional[BaseException],
+        exc_tb: Optional[TracebackType],
+    ) -> Optional[bool]:
+        self.stop()
+        return None
+
+    def stop(self, *args: Any) -> None:
+        """Stop the SingleStoreDB server."""
+        if self._connected is not None:
+            self._restore_server_urls()
+            try:
+                requests.get(
+                    'https://shell.singlestore.com/api/terminate',
+                    cookies=self._cookies,
+                )
+            finally:
+                self._connected = False
+
+
+def start() -> SingleStoreDB:
+    """
+    Manager for SingleStoreDB server running in Docker.
+
+    Returns
+    -------
+    SingleStoreDB
+
+    """
+    return SingleStoreDB()

singlestoredb/tests/alltypes.sql

@@ -0,0 +1,307 @@
+CREATE TABLE IF NOT EXISTS alltypes (
+    `id` INT(11),
+    `tinyint` TINYINT,
+    `unsigned_tinyint` TINYINT UNSIGNED,
+    `bool` BOOL,
+    `boolean` BOOLEAN,
+    `smallint` SMALLINT,
+    `unsigned_smallint` SMALLINT UNSIGNED,
+    `mediumint` MEDIUMINT,
+    `unsigned_mediumint` MEDIUMINT UNSIGNED,
+    `int24` MEDIUMINT,
+    `unsigned_int24` MEDIUMINT UNSIGNED,
+    `int` INT,
+    `unsigned_int` INT UNSIGNED,
+    `integer` INTEGER,
+    `unsigned_integer` INTEGER UNSIGNED,
+    `bigint` BIGINT,
+    `unsigned_bigint` BIGINT UNSIGNED,
+    `float` FLOAT,
+    `double` DOUBLE,
+    `real` REAL,
+    `decimal` DECIMAL(20,6),
+    `dec` DEC(20,6),
+    `fixed` FIXED(20,6),
+    `numeric` NUMERIC(20,6),
+    `date` DATE,
+    `time` TIME,
+    `time_6` TIME(6),
+    `datetime` DATETIME,
+    `datetime_6` DATETIME(6),
+    `timestamp` TIMESTAMP,
+    `timestamp_6` TIMESTAMP(6),
+    `year` YEAR,
+    `char_100` CHAR(100),
+    `binary_100` BINARY(100),
+    `varchar_200` VARCHAR(200),
+    `varbinary_200` VARBINARY(200),
+    `longtext` LONGTEXT,
+    `mediumtext` MEDIUMTEXT,
+    `text` TEXT,
+    `tinytext` TINYTEXT,
+    `longblob` LONGBLOB,
+    `mediumblob` MEDIUMBLOB,
+    `blob` BLOB,
+    `tinyblob` TINYBLOB,
+    `json` JSON,
+--  `geographypoint` GEOGRAPHYPOINT,
+--  `geography` GEOGRAPHY,
+    `enum` ENUM('one', 'two', 'three'),
+    `set` SET('one', 'two', 'three'),
+    `bit` BIT
+)
+COLLATE='utf8_unicode_ci';
+
+INSERT INTO alltypes SET
+    `id`=0,
+    `tinyint`=80,
+    `unsigned_tinyint`=85,
+    `bool`=0,
+    `boolean`=1,
+    `smallint`=-27897,
+    `unsigned_smallint`=27897,
+    `mediumint`=104729,
+    `unsigned_mediumint`=120999,
+    `int24`=-200899,
+    `unsigned_int24`=407709,
+    `int`=-1295369311,
+    `unsigned_int`=3872362332,
+    `integer`=-1741727421,
+    `unsigned_integer`=3198387363,
+    `bigint`=-266883847,
+    `unsigned_bigint`=980007287362,
+    `float`=-146486683.754744,
+    `double`=-474646154.719356,
+    `real`=-901409776.279346,
+    `decimal`=28111097.610822,
+    `dec`=389451155.931428,
+    `fixed`=-143773416.044092,
+    `numeric`=866689461.300046,
+    `date`='8524-11-10',
+    `time`='00:07:00',
+    `time_6`='01:10:00.000002',
+    `datetime`='9948-03-11 15:29:22',
+    `datetime_6`='1756-10-29 02:02:42.000008',
+    `timestamp`='1980-12-31 01:10:23',
+    `timestamp_6`='1991-01-02 22:15:10.000006',
+    `year`=1923,
+    `char_100`='This is a test of a 100 character column.',
+    `binary_100`=x'000102030405060708090A0B0C0D0E0F',
+    `varchar_200`='This is a test of a variable character column.',
+    `varbinary_200`=x'000102030405060708090A0B0C0D0E0F000102030405060708090A0B0C0D0E0F',
+    `longtext`='This is a longtext column.',
+    `mediumtext`='This is a mediumtext column.',
+    `text`='This is a text column.',
+    `tinytext`='This is a tinytext column.',
+    `longblob`=x'000102030405060708090A0B0C0D0E0F000102030405060708090A0B0C0D0E0F000102030405060708090A0B0C0D0E0F',
+    `mediumblob`=x'000102030405060708090A0B0C0D0E0F000102030405060708090A0B0C0D0E0F',
+    `blob`=x'000102030405060708090A0B0C0D0E0F',
+    `tinyblob`=x'0A0B0C0D0E0F',
+    `json`='{"a": 10, "b": 2.75, "c": "hello world"}',
+    `enum`='one',
+    `set`='two',
+    `bit`=128
+;
+
+INSERT INTO alltypes SET
+    `id`=1,
+    `tinyint`=NULL,
+    `bool`=NULL,
+    `boolean`=NULL,
+    `smallint`=NULL,
+    `mediumint`=NULL,
+    `int24`=NULL,
+    `int`=NULL,
+    `integer`=NULL,
+    `bigint`=NULL,
+    `float`=NULL,
+    `double`=NULL,
+    `real`=NULL,
+    `decimal`=NULL,
+    `dec`=NULL,
+    `fixed`=NULL,
+    `numeric`=NULL,
+    `date`=NULL,
+    `time`=NULL,
+    `time_6`=NULL,
+    `datetime`=NULL,
+    `datetime_6`=NULL,
+    `timestamp`=NULL,
+    `timestamp_6`=NULL,
+    `year`=NULL,
+    `char_100`=NULL,
+    `binary_100`=NULL,
+    `varchar_200`=NULL,
+    `longtext`=NULL,
+    `mediumtext`=NULL,
+    `text`=NULL,
+    `tinytext`=NULL,
+    `longblob`=NULL,
+    `mediumblob`=NULL,
+    `blob`=NULL,
+    `tinyblob`=NULL,
+    `json`=NULL,
+    `enum`=NULL,
+    `set`=NULL,
+    `bit`=NULL
+;
+
+-- Minimum values
+INSERT INTO alltypes SET
+    `id`=2,
+    `tinyint`=-128,
+    `unsigned_tinyint`=0,
+    `bool`=-128,
+    `boolean`=-128,
+    `smallint`=-32768,
+    `unsigned_smallint`=0,
+    `mediumint`=-8388608,
+    `unsigned_mediumint`=0,
+    `int24`=-8388608,
+    `unsigned_int24`=0,
+    `int`=-2147483648,
+    `unsigned_int`=0,
+    `integer`=-2147483648,
+    `unsigned_integer`=0,
+    `bigint`=-9223372036854775808,
+    `unsigned_bigint`=0,
+    `float`=0,
+    `double`=-1.7976931348623158e308,
+    `real`=-1.7976931348623158e308,
+    `decimal`=-99999999999999.999999,
+    `dec`=-99999999999999.999999,
+    `fixed`=-99999999999999.999999,
+    `numeric`=-99999999999999.999999,
+    `date`='1000-01-01',
+    `time`='-838:59:59',
+    `time_6`='-838:59:59.000000',
+    `datetime`='1000-01-01 00:00:00',
+    `datetime_6`='1000-01-01 00:00:00.000000',
+    `timestamp`='1970-01-01 00:00:01',
+    `timestamp_6`='1970-01-01 00:00:01.000000',
+    `year`=1901,
+    `char_100`='',
+    `binary_100`=x'',
+    `varchar_200`='',
+    `varbinary_200`=x'',
+    `longtext`='',
+    `mediumtext`='',
+    `text`='',
+    `tinytext`='',
+    `longblob`=x'',
+    `mediumblob`=x'',
+    `blob`=x'',
+    `tinyblob`=x'',
+    `json`='{}',
+    `enum`='one',
+    `set`='two',
+    `bit`=0
+;
+
+-- Maximum values
+INSERT INTO alltypes SET
+    `id`=3,
+    `tinyint`=127,
+    `unsigned_tinyint`=255,
+    `bool`=127,
+    `boolean`=127,
+    `smallint`=32767,
+    `unsigned_smallint`=65535,
+    `mediumint`=8388607,
+    `unsigned_mediumint`=16777215,
+    `int24`=8388607,
+    `unsigned_int24`=16777215,
+    `int`=2147483647,
+    `unsigned_int`=4294967295,
+    `integer`=2147483647,
+    `unsigned_integer`=4294967295,
+    `bigint`=9223372036854775807,
+    `unsigned_bigint`=18446744073709551615,
+    `float`=0,
+    `double`=1.7976931348623158e308,
+    `real`=1.7976931348623158e308,
+    `decimal`=99999999999999.999999,
+    `dec`=99999999999999.999999,
+    `fixed`=99999999999999.999999,
+    `numeric`=99999999999999.999999,
+    `date`='9999-12-31',
+    `time`='838:59:59',
+    `time_6`='838:59:59.999999',
+    `datetime`='9999-12-31 23:59:59',
+    `datetime_6`='9999-12-31 23:59:59.999999',
+    `timestamp`='2038-01-18 21:14:07',
+    `timestamp_6`='2038-01-18 21:14:07.999999',
+    `year`=2155,
+    `char_100`='',
+    `binary_100`=x'',
+    `varchar_200`='',
+    `varbinary_200`=x'',
+    `longtext`='',
+    `mediumtext`='',
+    `text`='',
+    `tinytext`='',
+    `longblob`=x'',
+    `mediumblob`=x'',
+    `blob`=x'',
+    `tinyblob`=x'',
+    `json`='{}',
+    `enum`='one',
+    `set`='two',
+    `bit`=18446744073709551615
+;
+
+-- Zero values
+--
+-- Note that v8 of SingleStoreDB does not allow zero date/times by
+-- default, so they are set to NULL here.
+--
+INSERT INTO alltypes SET
+    `id`=4,
+    `tinyint`=0,
+    `unsigned_tinyint`=0,
+    `bool`=0,
+    `boolean`=0,
+    `smallint`=0,
+    `unsigned_smallint`=0,
+    `mediumint`=0,
+    `unsigned_mediumint`=0,
+    `int24`=0,
+    `unsigned_int24`=0,
+    `int`=0,
+    `unsigned_int`=0,
+    `integer`=0,
+    `unsigned_integer`=0,
+    `bigint`=0,
+    `unsigned_bigint`=0,
+    `float`=0,
+    `double`=0.0,
+    `real`=0.0,
+    `decimal`=0.0,
+    `dec`=0.0,
+    `fixed`=0.0,
+    `numeric`=0.0,
+    `date`=NULL,
+    `time`='00:00:00',
+    `time_6`='00:00:00.000000',
+    `datetime`=NULL,
+    `datetime_6`=NULL,
+    `timestamp`=NULL,
+    `timestamp_6`=NULL,
+    `year`=NULL,
+    `char_100`='',
+    `binary_100`=x'',
+    `varchar_200`='',
+    `varbinary_200`=x'',
+    `longtext`='',
+    `mediumtext`='',
+    `text`='',
+    `tinytext`='',
+    `longblob`=x'',
+    `mediumblob`=x'',
+    `blob`=x'',
+    `tinyblob`=x'',
+    `json`='{}',
+    `enum`='one',
+    `set`='two',
+    `bit`=0
+;