> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pawsql.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> PawSQL 是一个产品：Cloud 是公网部署形态，Engine / Optimizer / Auditor / Advisor / Patroller 是同一产品的组件与交付形态，不是彼此独立的产品。 / PawSQL is a single product: Cloud is the public deployment form, while Engine / Optimizer / Auditor / Advisor / Patroller are components and delivery forms of the same product, not separate products.
> 术语以站内术语表为准：SQL 审核对应英文 SQL Review，查询重写对应 Query Rewrite，索引推荐对应 Index Recommendation；英文内容统一用 Review，不用 Audit。 / Use the site glossary for terminology: 审核 is SQL Review, 重写 is Query Rewrite, 索引推荐 is Index Recommendation; English content uses Review, never Audit.
> 引用能力范围或版本支持时以对应页面为准；标注 unknown、或 status 非 published 的内容表示尚未经产品核实，不应作为事实引用。 / Cite capability scope and version support from the corresponding page; content marked unknown, or with a status other than published, is not yet product-verified and must not be cited as fact.

# Install IDE Extensions

> Install the PawSQL extension for DBeaver, JetBrains IDEs, or Visual Studio Code and connect it to a PawSQL service.

PawSQL IDE extensions bring SQL review and optimization into the editor. Each extension connects to PawSQL Cloud or PawSQL Server and operates within the projects and workspaces available to the authenticated user.

## Goal

Learn how to install the PawSQL extension for DBeaver, JetBrains IDEs, or Visual Studio Code and connect it to a PawSQL service.

## Before you install

* A supported DBeaver, JetBrains IDE, or Visual Studio Code version;
* the PawSQL Cloud or PawSQL Server endpoint;
* a client credential where required;
* access to the intended project and workspace;
* marketplace connectivity or an approved offline package.

## Install the extension

<Tabs>
  <Tab title="DBeaver">
    DBeaver installs extensions from a software repository rather than a marketplace. Available sources:

    * the official repository `https://www.pawsql.com/repository`; and
    * the [Eclipse Marketplace](https://marketplace.eclipse.org/content/sql-optimizer-index-advisor-pawsql-dbeaver) page for PawSQL.

    <Steps>
      <Step title="Open the install wizard">
        Choose **Help > Install New Software** in DBeaver.
      </Step>

      <Step title="Add the PawSQL repository">
        Enter the repository URL `https://www.pawsql.com/repository` in **Work with** and click **Add**.
      </Step>

      <Step title="Select and install">
        Select **PawSQL for DBeaver** and complete the wizard.
      </Step>

      <Step title="Restart DBeaver">
        Save open work and restart the client when prompted.
      </Step>
    </Steps>

    <Tip>
      After installation, confirm that **PawSQL Client** settings appear under Preferences. See [Review SQL Before Execution in DBeaver](/en/user-guide/dev-tools/dbeaver) for pre-execution review and threshold configuration.
    </Tip>
  </Tab>

  <Tab title="JetBrains">
    <Steps>
      <Step title="Open plugin settings">Open the IDE plugin-management page.</Step>
      <Step title="Find PawSQL">Search for PawSQL and verify the publisher.</Step>
      <Step title="Install and restart">Install the extension and restart the IDE if prompted.</Step>
    </Steps>
  </Tab>

  <Tab title="Visual Studio Code">
    <Steps>
      <Step title="Open Extensions">Open the Extensions view.</Step>
      <Step title="Find PawSQL">Search for PawSQL and verify the publisher.</Step>
      <Step title="Install">Install the extension and reload the window if requested.</Step>
    </Steps>
  </Tab>
</Tabs>

## Offline installation

When the IDE cannot reach the marketplace, use an offline package supplied by your administrator. Before installing, confirm:

* the package comes from PawSQL or an approved internal software repository;
* the version is compatible with both the IDE and the PawSQL service version;
* the package has passed your organization's security review;
* the upgrade and rollback path is defined.

The offline installation entry point varies by IDE version; use the plugin-management page for that IDE.

## Connect the extension

<Steps>
  <Step title="Open PawSQL settings">
    Use the IDE settings or the PawSQL tool window.
  </Step>

  <Step title="Enter the endpoint">
    Add the complete Cloud or Server URL and label test and production endpoints clearly.
  </Step>

  <Step title="Add credentials">
    Use the client’s secure credential facility where available. Do not store tokens in project files.
  </Step>

  <Step title="Test the connection">
    Verify network access, TLS trust, authentication, and service health.
  </Step>

  <Step title="Select context">
    Choose the organization, project, and workspace, then verify the database engine and schema.
  </Step>
</Steps>

## Validate the extension

1. Open a file containing a complete SQL statement.
2. Select a sanitized read-only query.
3. Run a PawSQL analysis command.
4. Confirm that a task is created and results return.
5. Verify database dialect and object resolution.

<Tip>
  If connectivity works but recommendations are unexpected, inspect the selected workspace before reinstalling the extension.
</Tip>

## Security guidance

* Never commit a token to source control.
* Use the IDE or operating system credential store.
* Separate production and non-production workspaces.
* Review generated changes before applying them to source code.
* Revoke credentials when a device or extension is no longer used.

## Troubleshooting

| Symptom                      | Check first                                             |
| ---------------------------- | ------------------------------------------------------- |
| Extension cannot be found    | IDE version, marketplace access, corporate proxy        |
| Connection test fails        | Endpoint, TLS certificate, proxy, token, service status |
| No workspace is available    | Project membership and workspace permissions            |
| SQL is only partially parsed | Selection boundaries, dialect, placeholders, delimiters |

## Expected Result

After installation and connection, the extension appears in the IDE, and a PawSQL analysis command can create a task and return results.

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" href="/en/user-guide/installation/authentication" />

  <Card title="Verify the installation" href="/en/user-guide/installation/verify-installation" />

  <Card title="Developer tools" href="/en/user-guide/dev-tools" />

  <Card title="Workspaces" href="/en/user-guide/workspaces" />
</CardGroup>