sqlcycli 1.0.2__tar.gz → 1.0.4__tar.gz

{sqlcycli-1.0.2/src/sqlcycli.egg-info → sqlcycli-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sqlcycli
-Version: 1.0.2
+Version: 1.0.4
 Summary: Fast MySQL driver build in Cython (Sync and Async).
 Home-page: https://github.com/AresJef/SQLCyCli
 Author: Jiefu Chen
@@ -24,31 +24,39 @@ Requires-Dist: mysqlclient>=2.2.0
 Created to be used in a project, this package is published to github for ease of management and installation across different modules.
 
 ### Installation
+
 Install from `PyPi`
-``` bash
+
+```bash
 pip install sqlcycli
 ```
 
 Install from `github`
-``` bash
+
+```bash
 pip install git+https://github.com/AresJef/SQLCyCli.git
 ```
 
 For Linux systems, if you encounter the following error when installing the SQLCyCli dependency [mysqlclient](https://github.com/PyMySQL/mysqlclient):
+
 ```
 Exception: Can not find valid pkg-config name.
 Specify MYSQLCLIENT_CFLAGS and MYSQLCLIENT_LDFLAGS env vars manually
 ```
+
 Try the following to fix dependency issue (source: [Stack Overflow](https://stackoverflow.com/questions/76585758/mysqlclient-cannot-install-via-pip-cannot-find-pkg-config-name-in-ubuntu)):
+
 ```bash
 sudo apt-get install pkg-config python3-dev default-libmysqlclient-dev build-essential
 ```
 
 ### Requirements
+
 - Python 3.10 or higher.
 - MySQL 5.5 or higher.
 
 ### Features
+
 - Written in [Cython](https://cython.org/) for optimal performance (especially for SELECT/INSERT query).
 - All classes and methods are well documented and static typed.
 - Supports both `Sync` and `Async` connection to the server.
@@ -56,7 +64,9 @@ sudo apt-get install pkg-config python3-dev default-libmysqlclient-dev build-ess
 - Support conversion (escape) for most of the native python types, and objects from libaray [numpy](https://github.com/numpy/numpy) and [pandas](https://github.com/pandas-dev/pandas). Does `NOT` support custom conversion (escape).
 
 ### Benchmark
+
 The following result comes from [benchmark](./src/benchmark.py):
+
 - Device: MacbookPro M1Pro(2E8P) 32GB
 - Python: 3.12.4
 - MySQL: 8.3.0
@@ -64,19 +74,33 @@ The following result comes from [benchmark](./src/benchmark.py):
 - PyMySQL: 1.1.1
 - aiomysql: 0.2.0
 - asyncmy: 0.2.9
+
+```
+# Unit: second | Lower is better
+name        type    rows    insert-per-row  insert-bulk select-per-row  select-all
+mysqlclient sync    50000   1.730551        0.417242    1.738128        0.119030
+SQLCyCli    sync    50000   2.342858        0.291653    2.491601        0.063667
+PyMySQL     sync    50000   2.759374        0.424672    4.538553        0.328897
+SQLCyCli    async   50000   3.619818        0.292900    4.608713        0.143482
+aiomysql    async   50000   3.762054        0.404407    5.547093        0.331927
+asyncmy     async   50000   4.026993        0.416270    5.996335        0.324749
+```
+
 ```
 # Unit: second | Lower is better
-name        type    rows    insert-per-row  insert-bulk select-per-row  select-all  update-per-row  update-all  delete-per-row  delete-all
-mysqlclient sync    50000   1.734200        0.427027    1.756226        0.117552    1.901870        0.365056    1.651022        0.131151
-SQLCyCli    sync    50000   2.203967        0.293410    2.331576        0.062152    2.279076        0.352106    2.115025        0.107902
-PyMySQL     sync    50000   2.607349        0.412063    4.219286        0.321089    2.572826        0.345419    2.304015        0.104720
-SQLCyCli    async   50000   3.342991        0.270254    4.297667        0.141201    3.466729        0.346168    3.343880        0.105293
-aiomysql    async   50000   3.464662        0.384193    5.115068        0.322858    3.582689        0.345661    3.444377        0.104894
-asyncmy     async   50000   3.851011        0.416715    5.604330        0.314939    3.824736        0.346903    3.580444        0.104748
+name        type    rows    update-per-row  update-all  delete-per-row  delete-all
+mysqlclient sync    50000   1.823490        0.349495    1.585233        0.108128
+SQLCyCli    sync    50000   2.478617        0.357437    2.240017        0.111638
+PyMySQL     sync    50000   2.845172        0.358968    2.533066        0.111986
+SQLCyCli    async   50000   3.651250        0.363093    3.625302        0.110497
+aiomysql    async   50000   3.880559        0.358837    3.671028        0.105743
+asyncmy     async   50000   3.999616        0.361256    3.801010        0.106062
 ```
 
 ### Usage
+
 #### Use `connect()` to create one connection (`Sync` or `Async`) to the server.
+
 ```python
 import asyncio
 import sqlcycli
@@ -112,6 +136,7 @@ if __name__ == "__main__":
 ```
 
 #### Use `create_pool()` to create a Pool for managing and maintaining `Async` connections to the server.
+
 ```python
 import asyncio
 import sqlcycli
@@ -171,11 +196,14 @@ if __name__ == "__main__":
 ```
 
 ### Acknowledgements
+
 SQLCyCli is build on top of the following open-source repositories:
+
 - [aiomysql](https://github.com/aio-libs/aiomysql)
 - [PyMySQL](https://github.com/PyMySQL/PyMySQL)
 
 SQLCyCli is based on the following open-source repositories:
+
 - [numpy](https://github.com/numpy/numpy)
 - [orjson](https://github.com/ijl/orjson)
 - [pandas](https://github.com/pandas-dev/pandas)

{sqlcycli-1.0.2 → sqlcycli-1.0.4}/README.md

@@ -3,31 +3,39 @@
 Created to be used in a project, this package is published to github for ease of management and installation across different modules.
 
 ### Installation
+
 Install from `PyPi`
-``` bash
+
+```bash
 pip install sqlcycli
 ```
 
 Install from `github`
-``` bash
+
+```bash
 pip install git+https://github.com/AresJef/SQLCyCli.git
 ```
 
 For Linux systems, if you encounter the following error when installing the SQLCyCli dependency [mysqlclient](https://github.com/PyMySQL/mysqlclient):
+
 ```
 Exception: Can not find valid pkg-config name.
 Specify MYSQLCLIENT_CFLAGS and MYSQLCLIENT_LDFLAGS env vars manually
 ```
+
 Try the following to fix dependency issue (source: [Stack Overflow](https://stackoverflow.com/questions/76585758/mysqlclient-cannot-install-via-pip-cannot-find-pkg-config-name-in-ubuntu)):
+
 ```bash
 sudo apt-get install pkg-config python3-dev default-libmysqlclient-dev build-essential
 ```
 
 ### Requirements
+
 - Python 3.10 or higher.
 - MySQL 5.5 or higher.
 
 ### Features
+
 - Written in [Cython](https://cython.org/) for optimal performance (especially for SELECT/INSERT query).
 - All classes and methods are well documented and static typed.
 - Supports both `Sync` and `Async` connection to the server.
@@ -35,7 +43,9 @@ sudo apt-get install pkg-config python3-dev default-libmysqlclient-dev build-ess
 - Support conversion (escape) for most of the native python types, and objects from libaray [numpy](https://github.com/numpy/numpy) and [pandas](https://github.com/pandas-dev/pandas). Does `NOT` support custom conversion (escape).
 
 ### Benchmark
+
 The following result comes from [benchmark](./src/benchmark.py):
+
 - Device: MacbookPro M1Pro(2E8P) 32GB
 - Python: 3.12.4
 - MySQL: 8.3.0
@@ -43,19 +53,33 @@ The following result comes from [benchmark](./src/benchmark.py):
 - PyMySQL: 1.1.1
 - aiomysql: 0.2.0
 - asyncmy: 0.2.9
+
+```
+# Unit: second | Lower is better
+name        type    rows    insert-per-row  insert-bulk select-per-row  select-all
+mysqlclient sync    50000   1.730551        0.417242    1.738128        0.119030
+SQLCyCli    sync    50000   2.342858        0.291653    2.491601        0.063667
+PyMySQL     sync    50000   2.759374        0.424672    4.538553        0.328897
+SQLCyCli    async   50000   3.619818        0.292900    4.608713        0.143482
+aiomysql    async   50000   3.762054        0.404407    5.547093        0.331927
+asyncmy     async   50000   4.026993        0.416270    5.996335        0.324749
+```
+
 ```
 # Unit: second | Lower is better
-name        type    rows    insert-per-row  insert-bulk select-per-row  select-all  update-per-row  update-all  delete-per-row  delete-all
-mysqlclient sync    50000   1.734200        0.427027    1.756226        0.117552    1.901870        0.365056    1.651022        0.131151
-SQLCyCli    sync    50000   2.203967        0.293410    2.331576        0.062152    2.279076        0.352106    2.115025        0.107902
-PyMySQL     sync    50000   2.607349        0.412063    4.219286        0.321089    2.572826        0.345419    2.304015        0.104720
-SQLCyCli    async   50000   3.342991        0.270254    4.297667        0.141201    3.466729        0.346168    3.343880        0.105293
-aiomysql    async   50000   3.464662        0.384193    5.115068        0.322858    3.582689        0.345661    3.444377        0.104894
-asyncmy     async   50000   3.851011        0.416715    5.604330        0.314939    3.824736        0.346903    3.580444        0.104748
+name        type    rows    update-per-row  update-all  delete-per-row  delete-all
+mysqlclient sync    50000   1.823490        0.349495    1.585233        0.108128
+SQLCyCli    sync    50000   2.478617        0.357437    2.240017        0.111638
+PyMySQL     sync    50000   2.845172        0.358968    2.533066        0.111986
+SQLCyCli    async   50000   3.651250        0.363093    3.625302        0.110497
+aiomysql    async   50000   3.880559        0.358837    3.671028        0.105743
+asyncmy     async   50000   3.999616        0.361256    3.801010        0.106062
 ```
 
 ### Usage
+
 #### Use `connect()` to create one connection (`Sync` or `Async`) to the server.
+
 ```python
 import asyncio
 import sqlcycli
@@ -91,6 +115,7 @@ if __name__ == "__main__":
 ```
 
 #### Use `create_pool()` to create a Pool for managing and maintaining `Async` connections to the server.
+
 ```python
 import asyncio
 import sqlcycli
@@ -150,11 +175,14 @@ if __name__ == "__main__":
 ```
 
 ### Acknowledgements
+
 SQLCyCli is build on top of the following open-source repositories:
+
 - [aiomysql](https://github.com/aio-libs/aiomysql)
 - [PyMySQL](https://github.com/PyMySQL/PyMySQL)
 
 SQLCyCli is based on the following open-source repositories:
+
 - [numpy](https://github.com/numpy/numpy)
 - [orjson](https://github.com/ijl/orjson)
 - [pandas](https://github.com/pandas-dev/pandas)

{sqlcycli-1.0.2 → sqlcycli-1.0.4}/pyproject.toml

@@ -2,7 +2,7 @@
 requires = [
     "setuptools>=68.0.0",
     "wheel>=0.41.0",
-    "Cython==3.0.10",
+    "Cython>=3.0.10",
     "numpy>=1.25.2",
 ]
 build-backend = "setuptools.build_meta"

{sqlcycli-1.0.2 → sqlcycli-1.0.4}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = sqlcycli
-version = 1.0.2
+version = 1.0.4
 author = Jiefu Chen
 author_email = keppa1991@163.com
 description = Fast MySQL driver build in Cython (Sync and Async).

{sqlcycli-1.0.2 → sqlcycli-1.0.4}/src/sqlcycli/__init__.py

@@ -1,7 +1,8 @@
 from sqlcycli import constants, errors
+from sqlcycli._ssl import SSL
 from sqlcycli._auth import AuthPlugin
 from sqlcycli._optionfile import OptionFile
-from sqlcycli._ssl import SSL, SSL_ENABLED
+from sqlcycli.transcode import escape, BIT, JSON
 from sqlcycli.charset import Charset, all_charsets
 from sqlcycli.protocol import MysqlPacket, FieldDescriptorPacket
 from sqlcycli.connection import (
@@ -20,14 +21,14 @@ from sqlcycli._connect import connect, create_pool
 
 
 __all__ = [
+    # Module
     "constants",
     "errors",
+    # Class
     "AuthPlugin",
     "OptionFile",
     "SSL",
-    "SSL_ENABLED",
     "Charset",
-    "all_charsets",
     "MysqlPacket",
     "FieldDescriptorPacket",
     "Cursor",
@@ -41,6 +42,12 @@ __all__ = [
     "aio",
     "Pool",
     "PoolConnection",
+    # Type
+    "BIT",
+    "JSON",
+    # Function
+    "all_charsets",
+    "escape",
     "connect",
     "create_pool",
 ]