{"id":32551200,"url":"https://github.com/aziontech/edgesql-shell","last_synced_at":"2025-10-28T20:59:26.392Z","repository":{"id":249310493,"uuid":"773289845","full_name":"aziontech/edgesql-shell","owner":"aziontech","description":"A command-line interface for interacting with Azion's EdgeSQL service.","archived":false,"fork":false,"pushed_at":"2025-10-20T09:35:38.000Z","size":1716,"stargazers_count":4,"open_issues_count":3,"forks_count":3,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-10-24T13:58:05.745Z","etag":null,"topics":["azion","cli","edge-computing","edgesql","sql","sqlite"],"latest_commit_sha":null,"homepage":"https://www.azion.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aziontech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-03-17T09:04:58.000Z","updated_at":"2025-10-14T12:22:39.000Z","dependencies_parsed_at":"2024-07-20T01:10:30.617Z","dependency_job_id":"db8e35c1-9981-4a60-8a96-37490a198721","html_url":"https://github.com/aziontech/edgesql-shell","commit_stats":null,"previous_names":["aziontech/edgesql-shell"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aziontech/edgesql-shell","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aziontech%2Fedgesql-shell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aziontech%2Fedgesql-shell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aziontech%2Fedgesql-shell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aziontech%2Fedgesql-shell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aziontech","download_url":"https://codeload.github.com/aziontech/edgesql-shell/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aziontech%2Fedgesql-shell/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281512680,"owners_count":26514302,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-28T02:00:06.022Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["azion","cli","edge-computing","edgesql","sql","sqlite"],"created_at":"2025-10-28T20:58:57.427Z","updated_at":"2025-10-28T20:59:26.384Z","avatar_url":"https://github.com/aziontech.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/logo.png\" alt=\"Azion Edge SQL Shell Logo\" width=\"200\"/\u003e\n\u003c/p\u003e\n\n# EdgeSQL Shell\n\n[![python](https://img.shields.io/badge/Python-3.12-3776AB.svg?style=flat\u0026logo=python\u0026logoColor=white)](https://www.python.org)\n![License](https://img.shields.io/badge/license-MIT-blue.svg)\n\nEdgeSQL Shell is a command-line interface (CLI) tool for interacting with Azion EdgeSQL Database, allowing users to manage databases, Execute SQL commands on Azion EdgeSQL databases.\n\n## EdgeSQL Shell Documentation Index\n\n- [EdgeSQL Shell](#edgesql-shell)\n  - [EdgeSQL Shell Documentation Index](#edgesql-shell-documentation-index)\n  - [Features](#features)\n  - [Requirements](#requirements)\n  - [Installation](#installation)\n  - [Usage](#usage)\n  - [Other Settings](#other-settings)\n    - [Setting Custom Azion API Entrypoint](#setting-custom-azion-api-entrypoint)\n    - [Setting Kaggle Credentials](#setting-kaggle-credentials)\n    - [Setting MySQL Credentials](#setting-mysql-credentials)\n    - [Setting SQLite Usage](#setting-sqlite-usage)\n    - [Setting PostgreSQL Credentials](#setting-postgresql-credentials)\n    - [Setting Turso Credentials](#setting-turso-credentials)\n  - [Contributing](#contributing)\n  - [License](#license)\n\n## Features\n\n- List all tables in a database\n- Describe table schema\n- Dump table structure as SQL\n- List all databases\n- Switch to a database by name\n- Retrieve information about the current database\n- Load and execute SQL statements from a file\n- Create, destroy, or list databases\n- Support for multiline SQL commands\n- Transaction support\n- Output to standard output or file\n- Output on formats Tabular, CSV, JSON, HTML, Markdown, and Raw\n- Data Importation:\n\t- Adaptive chunk estimation\n\t- Vector Similarity Search support:\n\t\t- Datatype (F32_BLOB / FLOAT32)\n\t\t- Use vector function to convert vector from string representation into the binary format\n\t- From file files: CSV or XLSX capability\n\t- From databases: Mysql, PostgreSQL or SQLite\n\t- From Kaggle Datasets\n\t- From libSQL from Turso\n- Error handling and graceful exit\n- Interactive and noninteractive execution\n\n## Requirements\n\n- Python 3.x\n- Library Psycopg2\n- MySQL Connector/Python \n\n## Installation\n\n1. Clone this repository:\n\n   ```bash\n   git clone git@github.com:aziontech/edgesql-shell.git\n   ```\n2. Install the system dependencies:\n   \n\t- [mysql-connector-python](https://pypi.org/project/mysql-connector-python/)\n\t- [psycopg2](https://pypi.org/project/psycopg2/)\n   \n3. Install the Python dependencies:\n\n   ```bash\n   python -m venv env\n   source env/bin/activate\n   brew install postgresql\n   pip install -r requirements.txt\n   ```\n\n## Usage\n\n1. Set your Azion authentication token as an environment variable:\n\n   ```bash\n    export AZION_TOKEN=\"your_auth_token_here\"\n   ```\n\n2. Run the EdgeSQL Shell:\n\n   For interactive mode:\n   \n   ```bash\n   python edgesql-shell.py\n   ```\n\n   For noninteractive mode:\n\n   ```bash\n    python3 edgesql-shell.py -n -c \".use MyDB2024\" -c \".tables\"\n   ```\n\n4. Use the commands listed below to interact with the EdgeSQL service:\n\n   ```bash\n   .tables\t\t\t\t                 # List all tables\n   .schema \u003ctable_name\u003e\t\t                 # Describe table schema\n   .dump [--schema-only|--data-only] \u003ctable_name\u003e   # Render database structure as SQL\n   .databases\t\t\t                 # List all databases\n   .use \u003cdatabase_name\u003e\t\t                 # Switch to a database by name\n   .dbinfo\t\t\t\t                 # Get information about the current database\n   .read \u003cfile_name\u003e\t\t                 # Load and execute SQL statements from a file\n   .create \u003cdatabase_name\u003e\t\t                 # Create a new database\n   .destroy \u003cdatabase_name\u003e\t                 #  Destroy a database by name\n   .output stdout|file_path                         # Set the output to stdout or file\n   .mode tabular|csv|html|markdown|raw              # Set output mode\n   .import params table                             # Import data from file|mysql|postgres|kaggle|turso into TABLE\n   .dbsize\t\t\t\t                 # Get the size of the current database in MB\n   .exit\t\t\t\t                 # Exit the EdgeSQL Shell\n   ```\n   \n## Other Settings\n### Setting Custom Azion API Entrypoint ###\n \n ```bash\n   export AZION_BASE_URL=\"custom.api.azion.com\"\n ```\n \n### Setting Kaggle Credentials ###\n \n ```bash\n   export KAGGLE_USERNAME=\"username\"\n   export KAGGLE_KEY=\"kaggle_api_key\"\n ```\n \n### Setting MySQL Credentials ###\n \n ```bash\n   export MYSQL_USERNAME=\"username\"\n   export MYSQL_PASSWORD=\"password\"\n   export MYSQL_HOST=\"host_address\"\n ```\n \n Optional settings:\n \n ```bash\n   export MYSQL_PORT=\u003cport\u003e\n   \n   # For TLS connection\n   export MYSQL_SSL_CA=\"ssl_ca\"\n   export MYSQL_SSL_CERT=\"ssl_cert\"\n   export MYSQL_SSL_KEY=\"ssl_key\"\n   export MYSQL_SSL_VERIFY_CERT=True|False\n ```\n \n\n### Setting SQLite Usage ###\n\nSQLite databases are file-based and do not require credentials like other databases. To use an SQLite database, specify the path to the `.db` file in your import commands.\n\nExample:\n```bash\n.import sqlite /path/to/your/database.db source_table_name target_table_name\n```\n\n### Setting PostgreSQL Credentials ###\n \n ```bash\n   export POSTGRES_USERNAME=\"username\"\n   export POSTGRES_PASSWORD=\"password\"\n   export POSTGRES_HOST=\"host_address\"\n ```\n\n Optional settings:\n \n ```bash\n   export POSTGRES_PORT=\u003cport\u003e\n   \n   # For TLS connection\n   export POSTGRES_SSL_CA=\"ssl_ca\"\n   export POSTGRES_SSL_CERT=\"ssl_cert\"\n   export POSTGRES_SSL_KEY=\"ssl_key\"\n   export POSTGRES_SSL_VERIFY_CERT=True|False\n ```\n\n### Setting Turso Credentials ###\n\n  ```bash\n   export TURSO_DATABASE_URL=\u003chttps://\u003cdb_name\u003e-\u003corganization\u003e.turso.io\n   export TURSO_AUTH_TOKEN=\u003ctoken\u003e\n ```\n \n  Optional settings:\n \n ```bash\n   export TURSO_ENCRYPTION_KEY=\u003cencryption_key\u003e\n  ```\t\n\n  Tips for getting database credentials:\n  \n  Get the database URL:\n  \n ```bash\n   turso db show --url \u003cdatabase-name\u003e\n  ```\n  \n Get the database authentication token:\n \n  ```bash\n   turso db tokens create \u003cdatabase-name\u003e\n  ```\n\n\n## Contributing\n\nContributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faziontech%2Fedgesql-shell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faziontech%2Fedgesql-shell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faziontech%2Fedgesql-shell/lists"}