{"id":39306041,"url":"https://github.com/wirekang/adminjs-sql","last_synced_at":"2026-01-18T01:35:25.437Z","repository":{"id":58824632,"uuid":"533607558","full_name":"wirekang/adminjs-sql","owner":"wirekang","description":"SQL-based database adapter for AdminJS","archived":false,"fork":false,"pushed_at":"2023-12-20T04:57:29.000Z","size":654,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-02T17:35:06.589Z","etag":null,"topics":["adapter","admin-panel","adminjs","knex","mariadb","mysql","mysql2","node","provider"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/wirekang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-07T04:42:00.000Z","updated_at":"2023-10-10T08:08:09.000Z","dependencies_parsed_at":"2024-11-16T14:35:14.644Z","dependency_job_id":"fc3c7133-5a28-4af6-a94a-806b85c1baea","html_url":"https://github.com/wirekang/adminjs-sql","commit_stats":null,"previous_names":["wirekang/adminjs-mysql"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/wirekang/adminjs-sql","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wirekang%2Fadminjs-sql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wirekang%2Fadminjs-sql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wirekang%2Fadminjs-sql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wirekang%2Fadminjs-sql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wirekang","download_url":"https://codeload.github.com/wirekang/adminjs-sql/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wirekang%2Fadminjs-sql/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28526552,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T00:39:45.795Z","status":"ssl_error","status_checked_at":"2026-01-18T00:39:39.467Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["adapter","admin-panel","adminjs","knex","mariadb","mysql","mysql2","node","provider"],"created_at":"2026-01-18T01:35:25.303Z","updated_at":"2026-01-18T01:35:25.404Z","avatar_url":"https://github.com/wirekang.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Checkout [official @adminjs/sql](https://github.com/SoftwareBrothers/adminjs-sql) for Postgres.\n# This repository will be archived when the official adapter supports Mysql and Mariadb.\n\n---\n\n# [adminjs-sql](https://github.com/wirekang/adminjs-sql) [![NPM version](https://img.shields.io/npm/v/adminjs-sql?style=flat-square)](https://npmjs.org/package/adminjs-sql)\n\nThis is an unofficial [AdminJS](https://github.com/SoftwareBrothers/adminjs) adapter which integrates SQL-based database into AdminJS.\n\nInstallation: `yarn add adminjs-sql`\n\n\n## Usage\n\nThe plugin can be registered using standard `AdminJS.registerAdapter` method.\n\n```typescript\nimport { Adapter } from 'adminjs-sql';\nimport AdminJS from 'adminjs';\n\nAdminJS.registerAdapter(Adapter);\n```\n\nAfter registration, you should call `Adapter.init(client, connectionOptions)` to parse table information from running database.\n\n```typescript\n// import { Adapter } from 'adminjs-sql';\n// ...\nconst db = await Adapter.init('mysql2', {\n  host: DB_HOST,\n  port: DB_PORT,\n  user: DB_USER,\n  password: DB_PASSWORD,\n  database: DB_NAME,\n});\n```\n\nAfter initialization, you can register resources. `db.tables()` to register ALL tables in database. Or you can `db.table(tableName)` to register specific table.\n\n```typescript\nconst adminJs = new AdminJS({\n  databases: [db],\n  resources: db.tables(),\n  // or\n  resources: [db.table('users'), db.table('posts'), db.table('comments')],\n});\n```\n\n## ManyToOne\n\nThis supports ManyToOne relationship if you define a foreign key.\n\n## Example App\n\nYou can run [example app](https://github.com/wirekang/adminjs-sql/tree/main/example) with docker.\n\n1. Clone this repository.\n\n```\ngit clone https://github.com/wirekang/adminjs-sql\nyarn install\nyarn build\n```\n\n2. Setup example project.\n\n```\ncd example/\nyarn install\n```\n\n3. Run mysql:latest in docker container. Checkout [docker-compose.yml](https://github.com/wirekang/adminjs-sql/blob/main/example/docker-compose.yml)\n\n```\nyarn up\n\n```\n\n4. Run example app.\n\n```\nyarn start\n\n\n# Generating samples...\n# Inserting samples...\n# adminjs-sql example app is under http://localhost:33300\n```\n\n5. After enjoying the example, you can clean down MySQL server.\n\n```\nyarn down\n```\n\n## Testing\n\nWe use docker compose to run various databases for testing.\n\n`yarn test:up # docker compose up -d`\n\n`yarn test`\n\n`yarn test:down # docker compose down`\n\n## How It Works\n\n`adminjs-sql` collects information about tables and columns from [INFORMATION_SCHEMA](https://dev.mysql.com/doc/refman/8.0/en/information-schema-introduction.html) and converts to `adminjs`. This project uses [Knex Query Builder](https://knexjs.org) to generate SQL string.\n\n## Supported Databases\n\n- MySQL\n- MariaDB\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwirekang%2Fadminjs-sql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwirekang%2Fadminjs-sql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwirekang%2Fadminjs-sql/lists"}