{"id":15056865,"url":"https://github.com/kdcro101/vscode-cassandra","last_synced_at":"2025-04-10T04:55:54.195Z","repository":{"id":214641966,"uuid":"140439016","full_name":"kdcro101/vscode-cassandra","owner":"kdcro101","description":"Design and query Apache Cassandra database with help of generated templates, autocomplete and inline code decorations in Visual Studio Code","archived":false,"fork":false,"pushed_at":"2022-10-14T23:42:35.000Z","size":47270,"stargazers_count":22,"open_issues_count":15,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-24T06:11:28.339Z","etag":null,"topics":["apache-cassandra","cql","database","nosql","workbench"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kdcro101.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"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}},"created_at":"2018-07-10T13:48:42.000Z","updated_at":"2023-12-04T20:05:11.000Z","dependencies_parsed_at":"2023-12-29T15:52:14.696Z","dependency_job_id":null,"html_url":"https://github.com/kdcro101/vscode-cassandra","commit_stats":null,"previous_names":["kdcro101/vscode-cassandra"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdcro101%2Fvscode-cassandra","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdcro101%2Fvscode-cassandra/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdcro101%2Fvscode-cassandra/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kdcro101%2Fvscode-cassandra/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kdcro101","download_url":"https://codeload.github.com/kdcro101/vscode-cassandra/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248161259,"owners_count":21057554,"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","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":["apache-cassandra","cql","database","nosql","workbench"],"created_at":"2024-09-24T21:57:15.861Z","updated_at":"2025-04-10T04:55:54.173Z","avatar_url":"https://github.com/kdcro101.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cp align=\"left\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/kdcro101/vscode-cassandra/master/media/title.png\" title=\"Cassandra workbench for Visual Studio Code\" alt=\"Cassandra workbench for Visual Studio Code\"\u003e\n\u003c/p\u003e\n\n[![Visual Studio Marketplace](https://vsmarketplacebadge.apphb.com/version/kdcro101.vscode-cassandra.svg)](https://marketplace.visualstudio.com/items?itemName=kdcro101.vscode-cassandra)\n[![Installs](https://vsmarketplacebadge.apphb.com/installs-short/kdcro101.vscode-cassandra.svg)](https://marketplace.visualstudio.com/items?itemName=kdcro101.vscode-cassandra)\n[![Rating](https://vsmarketplacebadge.apphb.com/rating-short/kdcro101.vscode-cassandra.svg)](https://marketplace.visualstudio.com/items?itemName=kdcro101.vscode-cassandra#review-details)\n[![Build Status](https://travis-ci.com/kdcro101/vscode-cassandra.svg?branch=master)](https://travis-ci.com/kdcro101/vscode-cassandra)\n\n\nDesign and query Apache Cassandra database with help of generated templates, autocomplete and inline code decorations. \nSupports Apache Cassandra versions **`2.*`** and **`3.*`**\n\n\u003cp align=\"center\"\u003e\n   \u003cimg src=\"https://raw.githubusercontent.com/kdcro101/vscode-cassandra/master/media/res/cover.png\" /\u003e\n\u003c/p\u003e\n\n - [Quick start](#quick-start)\n - [Editor UI](#editor-ui)\n - [Limitations](#limitations)\n - [Key bindings](#key-bindings)\n - [Configuration](#configuration)\n - [Workspace configuration](#workspace-configuration)\n\n## Quick start\n\n\n\u003cp align=\"center\"\u003e\n   \u003cimg src=\"https://raw.githubusercontent.com/kdcro101/vscode-cassandra/master/media/res/panel-and-settings.png?image1\" /\u003e\n\u003c/p\u003e\n\nOpen **workspace** (workspace path is needed for configuration to generate), activate extension by running command from palette `Cassandra Workbench: Generate configuration`. This will generate `.cassandraWorkbench.jsonc` configuration file.\n\nSwitch to `Cassandra worbench` panel by clicking activity bar icon.\nEdit `.cassandraWorkbench.jsonc` to suit your needs. ([configuration](#configuration))\n\n## Editor UI\n\n\u003cp align=\"center\"\u003e\n   \u003cimg src=\"https://raw.githubusercontent.com/kdcro101/vscode-cassandra/master/media/res/editor-ui.png?image766ssad\" /\u003e\n\u003c/p\u003e\n\n## Limitations\n\nMultiple `SELECT` statements per script are not allowed. You will be notified by message:\n```\nUnable to execute multiple SELECT statements\n```\n\nMixing `SELECT` statements with data/structure altering statements is not allowed.  You will be notified by message: \n```\nUnable to execute SELECT statement along with data or structure altering statements\n```\n\n\n## Key bindings\n\n\n| Binding        |                       |\n| ------------- |------------------------|\n| `CTRL+ALT+F`  | Find in script         |\n| `CTRL+ALT+H`  | Replace in script      |\n| `CTRL+A`      | Select all |\n| `CTRL+ENTER`  | Execute script |\n\n## Configuration\n`.cassandraWorkbench.jsonc` file contains array of cluster connection items. \n\nAuthentication modes, currently supported ([more info](https://docs.datastax.com/en/cassandra/3.0/cassandra/configuration/secureConfigNativeAuth.html)):\n- AllowAllAuthenticator\n- PasswordAuthenticator\n\nWhen using `PasswordAuthenticator`, **user**, used to connect, must have **`SELECT`** permissions to access:\n- Cassandra 3.*\n    - `system_schema` keyspace \n- Cassandra 2.* \n    - `system.schema_aggregates`\n    - `system.schema_columnfamilies`\n    - `system.schema_columns`\n    - `system.schema_functions`\n    - `system.schema_keyspaces`\n    - `system.schema_triggers`\n    - `system.schema_usertypes`\n   \nDefault configuration (generated by `Cassandra Workbench: Generate configuration`):\n```ts\n// name must be unique!\n[\n    // AllowAllAuthenticator\n    {\n        \"name\": \"Cluster AllowAllAuthenticator\",\n        \"contactPoints\": [\"127.0.0.1\"]\n    },\n    //PasswordAuthenticator\n    {\n        \"name\": \"Cluster PasswordAuthenticator\",\n        \"contactPoints\": [\"127.0.0.1\"],\n        \"authProvider\": {\n            \"class\": \"PasswordAuthenticator\",\n            \"username\": \"yourUsername\",\n            \"password\": \"yourPassword\"\n        }\n    }\n]\n\n```\n\nAdd/remove and reconfigure cluster items as needed. \n\n\n\n## Workspace configuration\n`cassandraWorkbench.excludeKeyspaces`: `string[]` - default `[]`\n- list of regexp pattern to exclude when listing keyspaces in panel\n\nTo exclude `system` keyspaces use:\n```ts\n    \"cassandraWorkbench.excludeKeyspaces\": [\n            \"^system$\",\n            \"^system_auth$\",\n            \"^system_distributed$\",\n            \"^system_traces$\",\n            \"^system_schema$\"\n        ]\n```\n\n`cassandraWorkbench.useWorkspace` : `number` - default `0`\n- index of workspace where to look for configuration file `.cassandraWorkbench.jsonc`. For multi-root only.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkdcro101%2Fvscode-cassandra","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkdcro101%2Fvscode-cassandra","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkdcro101%2Fvscode-cassandra/lists"}