{"ref":"artifact:saptools-sqltools","page":"/artifacts/saptools-sqltools","json":"/artifacts/saptools-sqltools.json","generated":"2026-10-26","drafted_with_ai":true,"entity":{"id":"saptools-sqltools","name":"@saptools/sqltools","artifact_type":"cli","ecosystem":"btp","domain":"developer-experience","origin_ring":"independent","description":{"one_line":"A command line that turns the HANA service binding of a [Cloud Foundry](artifact:btp-cloud-foundry-runtime) app into a connection for the SQLTools extension in VS Code, written to the workspace's .vscode/settings.json.","short":"SQLTools connection from a Cloud Foundry app's HANA binding","what_it_solves":"Connecting the SQLTools extension in VS Code to an app's database otherwise means copying host, user, password and schema out of `VCAP_SERVICES` by hand. `sqltools-export` reads the bindings from a live app (`from-app` logs in with SAP_EMAIL and SAP_PASSWORD, `from-cf` uses the current `cf target`), from a saved JSON file or from stdin, and writes a `SAPHana` connection named `<app> (<region>)` together with a `hana-credentials.json` backup of every binding, both holding live credentials. It writes the connection and stops there: queries run in the [SQLTools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools) extension and the [SQLTools SAP HANA driver](https://marketplace.visualstudio.com/items?itemName=SAPSE.sql-driver-hana), which have to be installed. Only bindings under the `hana` service label are read, the default for [SAP HANA Cloud](artifact:btp-hana-cloud) and HDI bindings on BTP."},"links":{"npm":"https://www.npmjs.com/package/@saptools/sqltools","repo":"https://github.com/dongitran/saptools","docs":"https://github.com/dongitran/saptools/blob/main/packages/sqltools/README.md"},"identity":{"author":"dongitran","license":"MIT"},"compat":{"deployment":["cf"]},"type_properties":{"distribution":{"value":["npm"],"sources":[{"url":"https://github.com/dongitran/saptools","title":"@saptools/sqltools — README","checked":"2026-10-18","quote":"npm install -g @saptools/sqltools"}]}},"provides":["capability:editor-support"],"requires":[{"ref":"artifact:btp-hana-cloud","for":"The database whose service binding it converts; the parser reads bindings under the hana label only.","requirement":"required","sources":[{"url":"https://github.com/dongitran/saptools/blob/main/packages/sqltools/README.md","title":"dongitran/saptools — packages/sqltools/README.md","checked":"2026-10-15","quote":"The parser looks for the `hana` service label (the default for SAP HANA Cloud / HDI service bindings on BTP)."}]},{"ref":"external:nodejs","for":"It is a Node command line and library, and the README names the Node version it needs.","requirement":"required","sources":[{"url":"https://github.com/dongitran/saptools/blob/main/packages/sqltools/README.md","title":"dongitran/saptools — packages/sqltools/README.md","checked":"2026-10-15","quote":"Requires **Node.js ≥ 20**."}]}],"provenance":{"discovered_via":[{"source":"source:curator"}],"first_seen":"2026-10-15"},"maintainers":["actor:dong-tran"],"contributors":["actor:dong-tran"],"drafted_with_ai":true},"effective_normative_relations":[],"readings":{"liveness":[{"label":"Maintenance","tier":"good","evidence":"2 months since release"},{"label":"Continuity","tier":"fair","evidence":"2 contributors, 1 publisher"},{"label":"Repository","tier":"good","evidence":"pushed 2026-09, not archived"}],"compatibility":[{"label":"Declared for","tier":"unknown","evidence":"no BTP release lines in the atlas"},{"label":"Survived majors","tier":"unknown","evidence":"no BTP release lines in the atlas"},{"label":"Maintainer's CI","tier":"good","evidence":"CodeQL Security Scan green, 2026-09-18"}],"practice":[{"label":"Tests","tier":"good","evidence":"679 test files"},{"label":"Docs","tier":"good","evidence":"docs site, README 10 KB"},{"label":"Changelog","tier":"fair","evidence":"none in the repo"}],"reach":[{"value":25,"unit":"installs/week"},{"value":3,"unit":"watching"}]},"signals":{"crawled_at":"2026-10-26","latest_version":"0.2.1","majors":{"0.1":{"version":"0.1.2","date":"2026-04-19"},"0.2":{"version":"0.2.0","date":"2026-09-02"}},"license":"MIT","first_release":"2026-04-19","last_release":"2026-09-02","releases":7,"cadence_days":10,"maintainers":1,"repository":"git+https://github.com/dongitran/saptools.git","repository_directory":"packages/sqltools","peer_cds":null,"dependencies":2,"node_engine":">=20.0.0","test_script":false,"types":true,"downloads_weekly":25,"downloads_monthly":199,"stars":3,"forks":0,"open_issues":1,"archived":false,"pushed_at":"2026-09-18","license_spdx":null,"org_owned":false,"default_branch":"main","created_at":"2026-04-03T14:04:40Z","open_prs":1,"tree_truncated":false,"test_files":679,"workflows":33,"other_ci":false,"readme_bytes":10739,"docs_files":0,"changelog":false,"license_file":false,"dts_files":2,"first_commit":"2026-04-19","last_commit":"2026-09-02","commits":10,"contributors":2,"ci_status":"success","ci_run_at":"2026-09-18","ci_workflow":"CodeQL Security Scan","ci_event":"push","readme_path":"packages/sqltools/README.md","readme_sha":"3e030f1af893f6db0ea934096ae3112f6b7e0dfc","months_since_release":2,"dormant":false,"repo_read":"2026-10-26"},"release_notes":{"license":"MIT","quotable":true,"versions":[{"version":"0.2.1","date":"2026-09-02"},{"version":"0.2.0","date":"2026-09-02"},{"version":"0.1.6","date":"2026-06-30"},{"version":"0.1.5","date":"2026-06-29"},{"version":"0.1.4","date":"2026-04-29"},{"version":"0.1.3","date":"2026-04-19"},{"version":"0.1.2","date":"2026-04-19"}],"crawled_at":"2026-10-25"},"edges":{"maintainers":[{"ref":"actor:dong-tran","name":"Đông Trần","json":"/actors/dong-tran.json"}],"contributors":[{"ref":"actor:dong-tran","name":"Đông Trần","json":"/actors/dong-tran.json"}],"explained_by":[],"alternative_to_this":[],"needed_by":[],"available_via":[],"parts":[],"add_ons":[],"answered_through_parts":[]}}