netbox-sqlquery 0.1.0__tar.gz

netbox_sqlquery-0.1.0/LICENSE

@@ -0,0 +1,200 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. Please also get an original
+      source header from http://www.apache.org/legal/ to verify that
+      you have the correct license header.
+
+   Copyright 2026 Ravi Pina
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

netbox_sqlquery-0.1.0/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: netbox-sqlquery
+Version: 0.1.0
+Summary: SQL query interface for NetBox with syntax highlighting, abstract views, and role-based access control
+Author-email: Ravi Pina <ravi@pina.org>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ravinald/netbox-sqlquery
+Project-URL: Issues, https://github.com/ravinald/netbox-sqlquery/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# netbox-sqlquery
+
+[![CI](https://github.com/ravinald/netbox-sqlquery/actions/workflows/ci.yml/badge.svg)](https://github.com/ravinald/netbox-sqlquery/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+
+A NetBox plugin that provides a SQL query interface with syntax highlighting, abstract views, saved queries, and role-based access control.
+
+## Features
+
+- SQL console with real-time syntax highlighting and auto-uppercase keywords
+- Abstract views (`nb_*`) that resolve foreign keys to names and aggregate tags
+- Schema sidebar with search filter and Raw SQL / Views toggle
+- Interactive results: click columns to refine SELECT, click cells to add WHERE filters
+- Saved queries with save/load dialogs and private/public visibility
+- Write query support (INSERT, UPDATE, DELETE) with confirmation dialog
+- Role-based access control integrated with NetBox's ObjectPermission system
+- Per-user color preferences for syntax highlighting
+- CSV export
+- Compatible with NetBox 4.0 through 4.5, netbox-docker, and OIDC providers
+
+## Screenshots
+
+### Views mode
+Query abstract views that resolve foreign keys and aggregate tags, matching how data appears in the NetBox UI.
+
+<img src="docs/images/view-query.png" alt="Views mode query" width="800">
+
+### Raw SQL mode
+Query the database directly with full PostgreSQL power.
+
+<img src="docs/images/raw-query.png" alt="Raw SQL query" width="800">
+
+### Column select
+Click column headers to refine which columns are returned.
+
+<img src="docs/images/view-query-column-select.png" alt="Column selection" width="800">
+
+### Saving queries
+Save queries for reuse with private or public visibility.
+
+<img src="docs/images/saving-query.png" alt="Save query dialog" width="400">
+
+### Saved queries list
+
+<img src="docs/images/saved-query-list.png" alt="Saved queries list" width="800">
+
+### Permissions setup
+Control access using NetBox's native ObjectPermission system.
+
+<img src="docs/images/permissions.png" alt="Permissions setup" width="800">
+
+### User preferences
+Customize syntax highlighting colors per user.
+
+<img src="docs/images/user-preferences.png" alt="User preferences" width="800">
+
+## Compatibility
+
+See [COMPATIBILITY.md](COMPATIBILITY.md) for the full version matrix.
+
+| NetBox version | Python versions              |
+|----------------|------------------------------|
+| 4.0 - 4.5      | 3.10, 3.11, 3.12, 3.13, 3.14 |
+
+## Installation
+
+```bash
+pip install netbox-sqlquery
+```
+
+Add to your NetBox `configuration.py`:
+
+```python
+PLUGINS = ["netbox_sqlquery"]
+
+PLUGINS_CONFIG = {
+    "netbox_sqlquery": {
+        "require_superuser": True,
+        "max_rows": 1000,
+        "statement_timeout_ms": 10000,
+        "deny_tables": [
+            "auth_user",
+            "users_token",
+            "users_userconfig",
+        ],
+    }
+}
+```
+
+Run migrations:
+
+```bash
+python manage.py migrate netbox_sqlquery
+```
+
+Collect static files:
+
+```bash
+python manage.py collectstatic --no-input
+```
+
+For Docker-based installations, see [docs/docker.md](docs/docker.md).
+
+## Configuration
+
+| Setting                | Type | Default                                            | Description                                           |
+|------------------------|------|----------------------------------------------------|-------------------------------------------------------|
+| `require_superuser`    | bool | `True`                                             | Require superuser to access the query view            |
+| `max_rows`             | int  | `1000`                                             | Maximum rows returned per query                       |
+| `statement_timeout_ms` | int  | `10000`                                            | PostgreSQL statement timeout in milliseconds          |
+| `deny_tables`          | list | `["auth_user", "users_token", "users_userconfig"]` | Tables blocked for all users including superusers     |
+| `top_level_menu`       | bool | `False`                                            | Show as a top-level nav menu instead of under Plugins |
+
+## Documentation
+
+- [Installation](docs/installation.md)
+- [Configuration](docs/configuration.md)
+- [Usage](docs/usage.md)
+- [Permissions](docs/permissions.md)
+- [Saved queries](docs/saved-queries.md)
+- [Operations](docs/operations.md)
+- [Docker](docs/docker.md)
+- [Uninstalling](docs/uninstall.md)
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE).

netbox_sqlquery-0.1.0/README.md

@@ -0,0 +1,127 @@
+# netbox-sqlquery
+
+[![CI](https://github.com/ravinald/netbox-sqlquery/actions/workflows/ci.yml/badge.svg)](https://github.com/ravinald/netbox-sqlquery/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+
+A NetBox plugin that provides a SQL query interface with syntax highlighting, abstract views, saved queries, and role-based access control.
+
+## Features
+
+- SQL console with real-time syntax highlighting and auto-uppercase keywords
+- Abstract views (`nb_*`) that resolve foreign keys to names and aggregate tags
+- Schema sidebar with search filter and Raw SQL / Views toggle
+- Interactive results: click columns to refine SELECT, click cells to add WHERE filters
+- Saved queries with save/load dialogs and private/public visibility
+- Write query support (INSERT, UPDATE, DELETE) with confirmation dialog
+- Role-based access control integrated with NetBox's ObjectPermission system
+- Per-user color preferences for syntax highlighting
+- CSV export
+- Compatible with NetBox 4.0 through 4.5, netbox-docker, and OIDC providers
+
+## Screenshots
+
+### Views mode
+Query abstract views that resolve foreign keys and aggregate tags, matching how data appears in the NetBox UI.
+
+<img src="docs/images/view-query.png" alt="Views mode query" width="800">
+
+### Raw SQL mode
+Query the database directly with full PostgreSQL power.
+
+<img src="docs/images/raw-query.png" alt="Raw SQL query" width="800">
+
+### Column select
+Click column headers to refine which columns are returned.
+
+<img src="docs/images/view-query-column-select.png" alt="Column selection" width="800">
+
+### Saving queries
+Save queries for reuse with private or public visibility.
+
+<img src="docs/images/saving-query.png" alt="Save query dialog" width="400">
+
+### Saved queries list
+
+<img src="docs/images/saved-query-list.png" alt="Saved queries list" width="800">
+
+### Permissions setup
+Control access using NetBox's native ObjectPermission system.
+
+<img src="docs/images/permissions.png" alt="Permissions setup" width="800">
+
+### User preferences
+Customize syntax highlighting colors per user.
+
+<img src="docs/images/user-preferences.png" alt="User preferences" width="800">
+
+## Compatibility
+
+See [COMPATIBILITY.md](COMPATIBILITY.md) for the full version matrix.
+
+| NetBox version | Python versions              |
+|----------------|------------------------------|
+| 4.0 - 4.5      | 3.10, 3.11, 3.12, 3.13, 3.14 |
+
+## Installation
+
+```bash
+pip install netbox-sqlquery
+```
+
+Add to your NetBox `configuration.py`:
+
+```python
+PLUGINS = ["netbox_sqlquery"]
+
+PLUGINS_CONFIG = {
+    "netbox_sqlquery": {
+        "require_superuser": True,
+        "max_rows": 1000,
+        "statement_timeout_ms": 10000,
+        "deny_tables": [
+            "auth_user",
+            "users_token",
+            "users_userconfig",
+        ],
+    }
+}
+```
+
+Run migrations:
+
+```bash
+python manage.py migrate netbox_sqlquery
+```
+
+Collect static files:
+
+```bash
+python manage.py collectstatic --no-input
+```
+
+For Docker-based installations, see [docs/docker.md](docs/docker.md).
+
+## Configuration
+
+| Setting                | Type | Default                                            | Description                                           |
+|------------------------|------|----------------------------------------------------|-------------------------------------------------------|
+| `require_superuser`    | bool | `True`                                             | Require superuser to access the query view            |
+| `max_rows`             | int  | `1000`                                             | Maximum rows returned per query                       |
+| `statement_timeout_ms` | int  | `10000`                                            | PostgreSQL statement timeout in milliseconds          |
+| `deny_tables`          | list | `["auth_user", "users_token", "users_userconfig"]` | Tables blocked for all users including superusers     |
+| `top_level_menu`       | bool | `False`                                            | Show as a top-level nav menu instead of under Plugins |
+
+## Documentation
+
+- [Installation](docs/installation.md)
+- [Configuration](docs/configuration.md)
+- [Usage](docs/usage.md)
+- [Permissions](docs/permissions.md)
+- [Saved queries](docs/saved-queries.md)
+- [Operations](docs/operations.md)
+- [Docker](docs/docker.md)
+- [Uninstalling](docs/uninstall.md)
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE).

netbox_sqlquery-0.1.0/netbox_sqlquery/__init__.py

@@ -0,0 +1,72 @@
+import logging
+
+from netbox.plugins import PluginConfig
+
+logger = logging.getLogger("netbox_sqlquery")
+
+
+class NetBoxSQLQueryConfig(PluginConfig):
+    name = "netbox_sqlquery"
+    verbose_name = "SQL Query Explorer"
+    description = (
+        "SQL query interface for NetBox with syntax highlighting,"
+        " abstract views, and role-based access control"
+    )
+    version = "0.1.0"
+    author = "Ravi Pina"
+    author_email = "ravi@pina.org"
+    base_url = "sqlquery"
+    min_version = "4.0.0"
+    max_version = None
+    required_settings = []
+    default_settings = {
+        "require_superuser": True,
+        "max_rows": 1000,
+        "statement_timeout_ms": 10_000,
+        "deny_tables": [
+            "auth_user",
+            "users_token",
+            "users_userconfig",
+        ],
+        "top_level_menu": False,
+    }
+
+    # Suppress auto-loading; we register navigation conditionally in ready()
+    menu = None
+    menu_items = None
+
+    def ready(self):
+        super().ready()
+
+        # Register navigation based on top_level_menu setting
+        self._register_navigation()
+
+        # Create abstract SQL views
+        try:
+            from .abstract_schema import ensure_views
+            ensure_views()
+        except Exception as exc:
+            logger.warning(
+                "Could not create abstract SQL views: %s. "
+                "Run 'manage.py sqlquery_create_views' manually.",
+                exc,
+            )
+
+    def _register_navigation(self):
+        from netbox.plugins.registration import register_menu, register_menu_items
+
+        from .navigation import get_menu, get_menu_items
+
+        try:
+            from netbox.plugins import get_plugin_config
+            top_level = get_plugin_config("netbox_sqlquery", "top_level_menu")
+        except Exception:
+            top_level = False
+
+        if top_level:
+            register_menu(get_menu())
+        else:
+            register_menu_items(self.verbose_name, get_menu_items())
+
+
+config = NetBoxSQLQueryConfig