{"id":19031444,"url":"https://github.com/plandes/icsql","last_synced_at":"2025-09-14T21:18:36.206Z","repository":{"id":80107517,"uuid":"141031966","full_name":"plandes/icsql","owner":"plandes","description":"This library provides an Emacs SQL mode integration to the ciSQL program","archived":false,"fork":false,"pushed_at":"2023-10-23T16:17:04.000Z","size":92,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-23T16:28:21.242Z","etag":null,"topics":["command-line-tool","emacs","emacs-lisp","sql"],"latest_commit_sha":null,"homepage":null,"language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/plandes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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":"2018-07-15T14:01:51.000Z","updated_at":"2025-01-03T17:58:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"892278b7-9bc1-4c4d-a8a8-d52391bf9497","html_url":"https://github.com/plandes/icsql","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/plandes/icsql","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plandes%2Ficsql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plandes%2Ficsql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plandes%2Ficsql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plandes%2Ficsql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/plandes","download_url":"https://codeload.github.com/plandes/icsql/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plandes%2Ficsql/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275168718,"owners_count":25417182,"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-09-14T02:00:10.474Z","response_time":75,"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":["command-line-tool","emacs","emacs-lisp","sql"],"created_at":"2024-11-08T21:23:29.488Z","updated_at":"2025-09-14T21:18:36.186Z","avatar_url":"https://github.com/plandes.png","language":"Emacs Lisp","readme":"# Interface to ciSQL for interacting with relational databases.\n\n[![MELPA badge][melpa-badge]][melpa-link]\n[![MELPA stable badge][melpa-stable-badge]][melpa-stable-link]\n[![Build Status][build-badge]][build-link]\n\n\nThis library provides an [Emacs SQL mode] integration to the [ciSQL] program.\nIn addition it provides support for multiple buffers and fast/easy buffer (for\neach SQL connection) using the [buffer manage] library.\n\nFeatures:\n\n* [Emacs SQL mode] integration.\n* Utilization of JVM based [ciSQL]\n* Create customize connections using the Emacs customization system or start an\n  instance with no connection and then create the connection once you're in\n  [ciSQL].\n* Provides support for multiple buffers and fast/easy buffer (for each SQL\n  connection) using the [buffer manage] library.\n\n\n## Obtaining\n\nI have not put a few last touches on this before publishing\nto [Melpa](https://melpa.org/).  Create\nan [issue](https://github.com/plandes/icsql/issues/new) and I'll prioritize it\nfor anyone who wants it.\n\n\n## Installation\n\nThe package is available from [Melpa], and the preferred way is to installed\nusing the standard Emacs `M-x install-package` method.  [Java 8] also must be\ninstalled and used in the configuration by setting the environment variable\n`JAVA_HOME`.\n\n\n## Usage\n\n1. Copy [icsql.el](icsql.el) to your `~/.emacs.d` directory (or whever you keep\n   ad-hoc libraries).  See the [note](#obtaining) regarding making this a Melpa\n   library.\n2. In your `~/.emacs` file add: `(require 'icsql)`\n3. Optionally customize SQL connection(s) with `M-x customize-variable RET\n   icsql-connections`.  See the [connection](#connections) section for\n   specifics on each field.\n4. In Emacs: `M-x icsql` and `RET` to configure the library in `ciSQL` or give\n   the customized connection provided in the previous step.\n\n\n## Connections\n\nThe fields for connections with `icsql-connections` should be left blank or the\ndefault value if there is no meaningful value.  The fields are:\n\n* **Name**: Whatever string is meaningful to you.\n* **Product**: The product of the backing JDBC connection (i.e. `mysql`,\n  `oracle` etc) or leave the default for custom JDBC drivers that have no\n  correlated product.  See [below](#product) for more information on product.\n* **Host**: the fully qualified host name to connect to (if any)\n* **Database**: The data base name, or in some cases, the file (*sqlite*\n  driver) or directory (*csv* driver).\n* **User**: The login user name if any.\n* **Password**: The login password if any.\n* **Configuration**: A list of key value pairs that set variable(s) on [ciSQL] startup.\n\nSee the documentation in [connecting to a database] to specifics on each field.\n\nAn example entry for a [PostgreSQL] follows using\n`M-x customize-variable RET icsql-connections` follows:\n```bluespec\nName: my-postgres-entry\nProduct: postgres\nHost: localhost\nPort: 5432\nDatabase: mycooldb\nUser: joebob\nPassword: \u003csome password\u003e\n```\n\nThis entry, and an example SQLite entry can be set in the `~/.emacs` file as\nwell:\n```lisp\n(setq icsql-connections\n      '((\"my-sqlite-entry\" slite \"\" \"\" \"/path/to/db.sqlite3\" \"\" \"\" nil)\n        (\"my-postgres-entry\" postgres \"localhost\" \"5432\" \"mycooldb\" \"joebob\" \"some password\" nil)))\n```\n\n\n### Product\n\nFor more information on Emacs SQL products see the `sql-product-alist`\nvariable.  You can also get a full list of products with `M-:` and the following Lisp:\n```emacs-lisp\n(mapcar 'car sql-product-alist)\n```\n\n\n## Command Line Help\n\nYou can get command line help to the subordinate command line program [ciSQL]\nusing the following `icsql-help-command-line`.\n\n\n## Known Issues\n\nSee [cisql](https://github.com/plandes/cisql#known-issues) known issues.\n\n\n## License\n\nCopyright © 2018 - 2023 Paul Landes\n\nGNU Lesser General Public License, Version 2.0\n\n\n\u003c!-- links --\u003e\n\n[melpa-link]: https://melpa.org/#/icsql\n[melpa-stable-link]: https://stable.melpa.org/#/icsql\n[melpa-badge]: https://melpa.org/packages/icsql-badge.svg\n[melpa-stable-badge]: https://stable.melpa.org/packages/icsql-badge.svg\n[build-badge]: https://github.com/plandes/icsql/workflows/CI/badge.svg\n[build-link]: https://github.com/plandes/icsql/actions\n\n[Emacs SQL mode]: https://www.emacswiki.org/emacs/SqlMode\n[ciSQL]: https://github.com/plandes/cisql\n[buffer manage]: https://github.com/plandes/buffer-manage\n[connecting to a database]: https://github.com/plandes/cisql#connecting-to-a-database\n[PostgreSQL]: https://www.postgresql.org\n[Java 8]: https://www.java.com/en/download/help/java8.html\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplandes%2Ficsql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplandes%2Ficsql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplandes%2Ficsql/lists"}