harlequin-postgres

Name	harlequin-postgres JSON
Version	1.1.1 JSON
	download
home_page	None
Summary	A Harlequin adapter for Postgres.
upload_time	2025-02-05 22:35:42
maintainer	None
docs_url	None
author	Ted Conbeer
requires_python	<3.14,>=3.9
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # harlequin-postgres

This repo provides the Harlequin adapter for Postgres.

## Installation

`harlequin-postgres` depends on `harlequin`, so installing this package will also install Harlequin.

### Using pip

To install this adapter into an activated virtual environment:
```bash
pip install harlequin-postgres
```

### Using poetry

```bash
poetry add harlequin-postgres
```

### Using pipx

If you do not already have Harlequin installed:

```bash
pip install harlequin-postgres
```

If you would like to add the Postgres adapter to an existing Harlequin installation:

```bash
pipx inject harlequin harlequin-postgres
```

### As an Extra
Alternatively, you can install Harlequin with the `postgres` extra:

```bash
pip install harlequin[postgres]
```

```bash
poetry add harlequin[postgres]
```

```bash
pipx install harlequin[postgres]
```

## Usage and Configuration

You can open Harlequin with the Postgres adapter by selecting it with the `-a` option and passing a [Posgres DSN](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING):

```bash
harlequin -a postgres "postgres://my-user:my-pass@localhost:5432/my-database"
```

You can also pass all or parts of the connection string as separate options. The following is equivalent to the above DSN:

```bash
harlequin -a postgres -h localhost -p 5432 -U my-user --password my-pass -d my-database
```

Many more options are available; to see the full list, run:

```bash
harlequin --help
```

## Manual Transactions

To use Manual transaction mode, click on the label in the Run Query Bar to toggle the transaction mode from Auto to Manual.

## Further Documentation

For more information, see the [Harlequin Docs](https://harlequin.sh/docs/postgres/index).
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "harlequin-postgres",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Ted Conbeer",
    "author_email": "tconbeer@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/d9/e6/a8e7474791ca694ae8b1f4ad1aa2eeca7fc1ccec10be20dbdd12be7acce0/harlequin_postgres-1.1.1.tar.gz",
    "platform": null,
    "description": "# harlequin-postgres\n\nThis repo provides the Harlequin adapter for Postgres.\n\n## Installation\n\n`harlequin-postgres` depends on `harlequin`, so installing this package will also install Harlequin.\n\n### Using pip\n\nTo install this adapter into an activated virtual environment:\n```bash\npip install harlequin-postgres\n```\n\n### Using poetry\n\n```bash\npoetry add harlequin-postgres\n```\n\n### Using pipx\n\nIf you do not already have Harlequin installed:\n\n```bash\npip install harlequin-postgres\n```\n\nIf you would like to add the Postgres adapter to an existing Harlequin installation:\n\n```bash\npipx inject harlequin harlequin-postgres\n```\n\n### As an Extra\nAlternatively, you can install Harlequin with the `postgres` extra:\n\n```bash\npip install harlequin[postgres]\n```\n\n```bash\npoetry add harlequin[postgres]\n```\n\n```bash\npipx install harlequin[postgres]\n```\n\n## Usage and Configuration\n\nYou can open Harlequin with the Postgres adapter by selecting it with the `-a` option and passing a [Posgres DSN](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING):\n\n```bash\nharlequin -a postgres \"postgres://my-user:my-pass@localhost:5432/my-database\"\n```\n\nYou can also pass all or parts of the connection string as separate options. The following is equivalent to the above DSN:\n\n```bash\nharlequin -a postgres -h localhost -p 5432 -U my-user --password my-pass -d my-database\n```\n\nMany more options are available; to see the full list, run:\n\n```bash\nharlequin --help\n```\n\n## Manual Transactions\n\nTo use Manual transaction mode, click on the label in the Run Query Bar to toggle the transaction mode from Auto to Manual.\n\n## Further Documentation\n\nFor more information, see the [Harlequin Docs](https://harlequin.sh/docs/postgres/index).",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Harlequin adapter for Postgres.",
    "version": "1.1.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1bb263ac1aeccc940a7abc561079b2d965d696da9691f5bac872eeb52efa19e5",
                "md5": "34b2ad395eaedc07eb307ad5f9880420",
                "sha256": "927dd124962f8eca6b9ead49b45ce43c3c71c97f8e58b246d8f2f3f31f612201"
            },
            "downloads": -1,
            "filename": "harlequin_postgres-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "34b2ad395eaedc07eb307ad5f9880420",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.9",
            "size": 17945,
            "upload_time": "2025-02-05T22:35:40",
            "upload_time_iso_8601": "2025-02-05T22:35:40.942076Z",
            "url": "https://files.pythonhosted.org/packages/1b/b2/63ac1aeccc940a7abc561079b2d965d696da9691f5bac872eeb52efa19e5/harlequin_postgres-1.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d9e6a8e7474791ca694ae8b1f4ad1aa2eeca7fc1ccec10be20dbdd12be7acce0",
                "md5": "7aef8cfc7585ea2f94b248d6a2f56f62",
                "sha256": "3ba0981b3b17aa72984bb36ea16dc1eac3398ade23c59fd14ac6f883e1ca369b"
            },
            "downloads": -1,
            "filename": "harlequin_postgres-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "7aef8cfc7585ea2f94b248d6a2f56f62",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.9",
            "size": 16557,
            "upload_time": "2025-02-05T22:35:42",
            "upload_time_iso_8601": "2025-02-05T22:35:42.910723Z",
            "url": "https://files.pythonhosted.org/packages/d9/e6/a8e7474791ca694ae8b1f4ad1aa2eeca7fc1ccec10be20dbdd12be7acce0/harlequin_postgres-1.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-05 22:35:42",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "harlequin-postgres"
}