DBCheck
RaccoonX(DBCheck): Database Inspection Tool
File Explorer
Download Latest Version (.zip)- bug_report.yml
- config.yml
- feature_request.yml
- docker-multiarch.yml
- docker.yml
- license-check.yml
- test.yml
- dbcheck_logo.png
- dbcheck_logo_banner.png
- dbcheck_logo_icon.png
- favicon.ico
- clickhouse.png
- db2.png
- dm.png
- dm8.png
- gbase.jpg
- gbase.png
- hgdb.png
- highgo-logo-en.png
- ivorysql.png
- kingbase.png
- mongodb.png
- mysql.png
- oceanbase.png
- oracle.png
- pg.png
- redis.png
- sqlserver.png
- tidb.png
- uxdb.png
- yashandb.png
- db2.svg
- placeholder.js
- matchbrackets.js
- show-hint.css
- show-hint.js
- sql-hint.js
- codemirror.css
- codemirror.js
- sql.js
- dracula.css
- monokai.css
- inspection_config.css
- login.css
- quotes.css
- xterm.css
- baseline_config.js
- echarts.min.js
- inspection_config.js
- login.js
- server_thresholds.js
- socket.io.min.js
- Sortable.min.js
- xterm-addon-attach.js
- xterm-addon-fit.js
- xterm.js
- auth-guard.js
- clickhouse.png
- db2.png
- dbcheck_logo.png
- dbcheck_logo_icon.png
- dbcheck_logo_info.png
- dm.png
- dm8.png
- favicon.ico
- gbase.png
- ivorysql.png
- kingbase.png
- mascot.png
- mascot_01.png
- mascot_02.png
- mongodb.png
- mysql.png
- oceanbase.png
- oracle.png
- pay-about.png
- pay-en.png
- pg.png
- postgresql.png
- redis.png
- script_extracted.js
- sqlserver.png
- tidb.png
- uxdb.png
- yashandb.png
- build_and_run.sh
- build_linux.sh
- build_macos.sh
- build_windows.bat
- dbcheck_linux.spec
- dbcheck_macos.spec
- dbcheck_windows.spec
- package_windows.py
- README.md
- runtime-hook-gevent.py
- oracle_awr.html
- user_management_schema.sql
- i18n_consistency_check.py
- i18n_qa_verify.py
- docker-compose.yml
- docker-entrypoint.sh
- Dockerfile
- release.ps1
- release.sh
- requirements-docker.txt
- requirements.txt
- start.bat
- start.sh
- PLUGIN_DESIGN.md
- rule-plugin-class.mermaid
- rule-plugin-sequence.mermaid
- STRATEGY_DBCheck.md
- v2.6.3-design.md
- INSTALL_zh.md
- dbcheck-proxy.conf
- enable-dm8.md
- oracle_jdbc_data_complete.md
- plugin-development-guide-v2.8.0.md
- plugin_independence_refactor.md
- plugin_lifecycle_implementation.md
- sqlserver-jdbc-java-env.md
- uninstall_cleanup_fix.md
- v26.8.20.0-release-notes.md
- CONTRIBUTING.md
- SECURITY.md
- clickhouse-jdbc-0.10.0-rc2-all.jar
- slf4j-api-2.0.16.jar
- db2jcc4.jar
- DmJdbcDriver11.jar
- DmJdbcDriver6.jar
- DmJdbcDriver7.jar
- DmJdbcDriver8.jar
- jdbc-3.5.1.jar
- jdbc-3.6.5.21.jar
- postgresql-42.7.13.jar
- HgdbJdbc-6.2.5.jar
- postgresql-42.2.2.jar
- hgdb-jdbc-v9.0.jar
- kingbase8-9.0.0.jar
- mariadb-java-client-3.5.10.jar
- mongodb-jdbc-3.0.8-all.jar
- mysql-connector-j-26.7.0.jar
- mysql-connector-j-8.0.33.jar
- mysql-connector-j-9.7.0.jar
- oceanbase-client-2.4.1.jar
- opengauss-jdbc-6.0.5.jar
- postgresql.jar
- ojdbc8.jar
- ojdbc6.jar
- ojdbc8.jar
- postgresql-42.7.13.jar
- jedis-8.0.0.jar
- mssql-jdbc-13.4.0.jre11.jar
- taos-jdbcdriver-3.9.0.jar
- mysql-connector-j-26.7.0.jar
- uxdbjdbc-2.1.2.3p.jre8.jar
- yashandb-jdbc-1.9.3.jar
- e2e_sqlserver_jdbc.py
- spike_mssql_jdbc.py
- __init__.py
- de.py
- en.py
- es.py
- fr.py
- ja.py
- ko.py
- ru.py
- zh.py
- zh_tw.py
- mysql_batch_template.xlsx
- oracle_batch_template.xlsx
- pg_batch_template.xlsx
- __init__.py
- builtin_registry.json
- builtin_types.json
- dbcheck-quotes.json
- doc_kb_seed.json
- drivers_seed.json
- version.json
- version.py
- __init__.py
- brand.py
- entry.py
- paths.py
- __init__.py
- dbtype_registry.py
- __init__.py
- __init__.py
- autobackup.py
- __init__.py
- engine.py
- routes.py
- scheduler_hook.py
- __init__.py
- crawler.py
- models.py
- routes.py
- service.py
- __init__.py
- cli.py
- main_dm.py
- main_gbase.py
- main_ivorysql.py
- main_kingbase.py
- main_mariadb.py
- main_mysql.py
- main_oceanbase.py
- main_oracle_full.py
- main_pg.py
- main_sqlserver.py
- main_sqlserver_dual.py
- main_tidb.py
- main_yashandb.py
- __init__.py
- dm8_offline.py
- drivers.py
- oracle_client.py
- __init__.py
- analyzer.py
- chapter_filter.py
- config_baseline.py
- dal.py
- db_history.py
- engine.py
- index_health.py
- init_db.py
- run.py
- slow_query.py
- __init__.py
- coordinator.py
- inspection_expert.py
- lock_analyst.py
- monitor_sentinel.py
- nl_query_expert.py
- rootcause_expert.py
- sql_governance.py
- __init__.py
- ai_helper.py
- context.py
- cost_optimizer.py
- db_executor.py
- diagnosis_store.py
- hub.py
- inspection_runner.py
- intel_inspection_cli.py
- planner.py
- registry.py
- schema_knowledge.json
- schema_knowledge.py
- specialist.py
- ticket_store.py
- views.py
- __init__.py
- __main__.py
- auth.py
- bootstrap.py
- server.py
- tools.py
- __init__.py
- engine.py
- queries.py
- __init__.py
- __init__.py
- core.py
- loader.py
- market.py
- type.py
- __init__.py
- base.py
- manager.py
- mysql_backup.py
- oracle_backup.py
- pg_backup.py
- sqlserver_backup.py
- clickhouse.yaml
- db2.yaml
- dm.yaml
- gbase.yaml
- hgdb.yaml
- ivorysql.yaml
- kingbase.yaml
- mariadb.yaml
- mongodb.yaml
- mysql.yaml
- oceanbase.yaml
- oceanbase_oracle.yaml
- oracle.yaml
- oracle_jdbc.yaml
- pg.yaml
- redis-cluster.yaml
- redis.yaml
- sqlserver.yaml
- tidb.yaml
- uxdb.yaml
- yasdb.yaml
- overrides.yaml
- __init__.py
- instance_manager.py
- metrics_collector.py
- remote_host_collector.py
- remote_host_shell.sh
- report_score.py
- rule_engine.py
- __init__.py
- document_processor.py
- embeddings.py
- manager.py
- retriever.py
- vector_store.py
- __init__.py
- inspect.py
- jdbc-3.5.1.jar
- __init__.py
- en.py
- zh.py
- analyzer.py
- config_baseline.py
- db_history.py
- dbcheck_logo.png
- desensitize.py
- index_health.py
- main.py
- main_dm.py
- main_gbase.py
- main_ivorysql.py
- main_kingbase.py
- main_mysql.py
- main_oracle_full.py
- main_pg.py
- main_sqlserver.py
- main_tidb.py
- main_yashandb.py
- mod_logger.py
- pdf_export.py
- run_inspection.py
- slow_query_analyzer.py
- version.py
- _meta.json
- _skillhub_meta.json
- requirements.txt
- __init__.py
- base.py
- dm.py
- mysql.py
- oracle.py
- postgres.py
- sqlserver.py
- __init__.py
- executor.py
- models.py
- parser.py
- rollback.py
- routes.py
- rules.py
- service.py
- __init__.py
- __init__.py
- db_manager.py
- menu.py
- permission.py
- role.py
- user.py
- __init__.py
- auth_routes.py
- menu_routes.py
- role_routes.py
- user_routes.py
- __init__.py
- auth_service.py
- menu_service.py
- perm_service.py
- role_service.py
- user_service.py
- __init__.py
- __init__.py
- auth_decorator.py
- jwt_util.py
- password.py
- __init__.py
- seed.py
- __init__.py
- api.py
- app.py
- auth.py
- awr_parser.py
- build_awr_word_report.py
- data_manager.py
- pdf_export.py
- scheduler.py
- driver_registry.py
- jdbc_connector.py
- jdbc_inspection_cli.py
- jdbc_metrics_cli.py
- jdbc_test_cli.py
- baseline_data.json
- connection_config.py
- jdbc_jvm.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- baseline_data.json
- connection_config.py
- jdbc_jvm.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- __init__.py
- plugin.json
- README.md
- baseline_data.json
- connection_config.py
- jdbc_jvm.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- baselines.json
- connection_config.py
- logo.png
- main_plugin.py
- plugin.json
- README.md
- requirements.txt
- sql_templates.json
- version_adapter.py
- dm8_wordtemplates_v1.0.docx
- gbase_wordtemplates_v1.0.docx
- ivorysql_wordtemplates_v1.0.docx
- kingbase_wordtemplates_v1.0.docx
- mysql_wordtemplates_v1.0.docx
- oracle_jdbc_wordtemplates_v1.0.docx
- postgresql_wordtemplates_v1.0.docx
- sqlserver_wordtemplates_v1.0.docx
- tidb_wordtemplates_v1.0.docx
- yashandb_wordtemplates_v1.0.docx
- baseline.json
- baseline_data.json
- inspection_engine.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- logo.png
- main_plugin.py
- plugin.json
- redis_common.py
- sql_templates.json
- logo.png
- main_plugin.py
- plugin.json
- sql_templates.json
- baseline_data.json
- connection_config.py
- jdbc_jvm.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- logo.png
- main_plugin.py
- plugin.json
- baseline_data.json
- connection_config.py
- jdbc_jvm.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- baseline_data.json
- connection_config.py
- jdbc_jvm.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- baseline_data.json
- connection_config.py
- jdbc_jvm.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- __init__.py
- plugin.json
- baseline_data.json
- connection_config.py
- jdbc_jvm.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- baselines.json
- connection_config.py
- logo.png
- main_plugin.py
- plugin.json
- requirements.txt
- sql_templates.json
- version_adapter.py
- baseline.json
- baseline_data.json
- inspection_engine.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- logo.png
- main_plugin.py
- plugin.json
- redis_common.py
- sql_templates.json
- logo.png
- main_plugin.py
- plugin.json
- sql_templates.json
- baseline_data.json
- connection_config.py
- jdbc_jvm.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- logo.png
- main_plugin.py
- plugin.json
- baseline_data.json
- connection_config.py
- jdbc_jvm.py
- logo.png
- main_plugin.py
- plugin.json
- template_data.json
- DEVELOPER_GUIDE.md
- plugin_registry.json
- __init__.py
- add_license_headers.py
- build-multiarch.sh
- build.sh
- check_license_headers.py
- diag_oceanbase.py
- init_mongodb_template.py
- inspection_api.py
- migrate_legacy_paths.py
- mod_logger.py
- mongo-test-standalone.bat
- mongo-test-standalone.sh
- pro_merge_dbs.py
- pro_scan_dbs.py
- push.sh
- refresh_hgdb_plugin_template.py
- rollback_paths.py
- seed_doc_kb.py
- architecture.png
- chat_demo.png
- dbcheck-badge-800w.png
- dbcheck-badge.png
- dbcheck_logo.png
- dbcheck_logo_badge.png
- dbcheck_logo_en.png
- dbcheck_logo_info.png
- dbcheck_logo_info_gray.png
- dbcheck_logo_zh.png
- demo.gif
- pay-en.png
- pay-en_gray.png
- pay.png
- pay_gray.png
- report-en.png
- report.png
- server_inspect.png
- share_management.png
- share_view.png
- skill0.png
- skill1.png
- webui0-en.png
- webui0.png
- webui1-en.png
- webui1.png
- webui10-en.png
- webui10.png
- webui11.png
- webui12.png
- webui13-en.png
- webui13.png
- webui15-en.png
- webui15.png
- webui16-en.png
- webui16.png
- webui17-en.png
- webui17.png
- webui2-en.png
- webui2.png
- webui3-en.png
- webui3.png
- webui5.png
- webui6-en.png
- webui6.png
- webui7-en.png
- webui7.png
- webui8-en.png
- webui8.png
- webui9-en.png
- webui9.png
- db2_wordtemplates_v1.0.docx
- dm8_wordtemplates_v1.0.docx
- gbase_wordtemplates_v1.0.docx
- hgdb_wordtemplates_v1.0.docx
- ivorysql_wordtemplates_v1.0.docx
- kingbase_wordtemplates_v1.0.docx
- mariadb_wordtemplates_v1.0.docx
- mongodb_wordtemplates_v1.0.docx
- mysql_wordtemplates_v1.0.docx
- oceanbase_wordtemplates_v1.0.docx
- oracle_jdbc_wordtemplates_v1.0.docx
- postgresql_wordtemplates_v1.0.docx
- redis_wordtemplates_v1.0.docx
- sqlserver_jdbc_wordtemplates_v1.0.docx
- sqlserver_wordtemplates_v1.0.docx
- tidb_wordtemplates_v1.0.docx
- uxdb_wordtemplates_v1.0.docx
- yashandb_wordtemplates_v1.0.docx
- admin.html
- login.html
- baseline_config.html
- index.html
- share.html
- test_sql_editor.html
- .dockerignore
- .env.example
- .gitattributes
- .gitignore
- AGENTS.md
- CHANGELOG.md
- LICENSE
- NOTICE
- pytest.ini
- README.md
- README_zh.md
- web_ui.py
# Installation Guide
1. Get the code
git clone https://github.com/fiyo/DBCheck
Downloads the entire project code from GitHub to your computer.
cd DBCheck
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull jackge12345/dbcheck:latest
Type this command into your terminal and run it.
docker run -d -p 5003:5003 \
Runs the built image as an actual container.
docker pull ghcr.io/fiyo/dbcheck:latest
Type this command into your terminal and run it.
curl -o deploy/docker-compose.yml https://raw.githubusercontent.com/fiyo/DBCheck/main/deploy/docker-compose.yml
Runs the command against the services defined in the compose file.
docker compose -f deploy/docker-compose.yml up -d
Runs the command against the services defined in the compose file.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
3. Python
EasyPrerequisites
pip install -r deploy/requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)
