{"id":18941165,"url":"https://github.com/couchbase-ecosystem/couchbase_jetbrains_plugin","last_synced_at":"2025-04-15T20:31:56.659Z","repository":{"id":167849115,"uuid":"642959288","full_name":"Couchbase-Ecosystem/couchbase_jetbrains_plugin","owner":"Couchbase-Ecosystem","description":"A Couchbase Plugin for the Jetbrains Platform","archived":false,"fork":false,"pushed_at":"2025-04-14T04:56:38.000Z","size":40832,"stargazers_count":11,"open_issues_count":49,"forks_count":1,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-04-14T05:34:35.659Z","etag":null,"topics":["couchbase","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Couchbase-Ecosystem.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"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,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-05-19T18:39:25.000Z","updated_at":"2025-04-11T11:09:35.000Z","dependencies_parsed_at":"2024-08-26T14:04:49.030Z","dependency_job_id":"2d20a84d-158e-46e9-8ee9-5e0df14bbadf","html_url":"https://github.com/Couchbase-Ecosystem/couchbase_jetbrains_plugin","commit_stats":null,"previous_names":["couchbaselabs/couchbase_jetbrains_plugin"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Couchbase-Ecosystem%2Fcouchbase_jetbrains_plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Couchbase-Ecosystem%2Fcouchbase_jetbrains_plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Couchbase-Ecosystem%2Fcouchbase_jetbrains_plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Couchbase-Ecosystem%2Fcouchbase_jetbrains_plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Couchbase-Ecosystem","download_url":"https://codeload.github.com/Couchbase-Ecosystem/couchbase_jetbrains_plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249147983,"owners_count":21220454,"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":["couchbase","hacktoberfest"],"created_at":"2024-11-08T12:26:23.913Z","updated_at":"2025-04-15T20:31:51.635Z","avatar_url":"https://github.com/Couchbase-Ecosystem.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Couchbase Jetbrains Plugin\n\nWelcome to the official Couchbase plugin for the Jetbrains Platform\n\nThe Couchbase JetBrains plugin provides support for Couchbase in JetBrains IDEs.\n\nThis means that you can use your favorite IDE to develop Couchbase applications, complete with code completion, syntax\nhighlighting, and debugging support.\n\n# Installation\n\nTo install the plugin just search for Couchbase inside the plugins market place or go\nto https://plugins.jetbrains.com/plugin/22131-couchbase\n\n# Quick Tour\n\n### Add Cluster Connection\n\nTo connect to a Couchbase Cluster, follow these steps:\n\n1. Click on the \"Add\" icon.\n2. Complete all the required fields with the necessary details.\n3. Check \"Use Secure Connection\" if you are connecting to Capella or if your connection is using HTTPS.\n4. Finally, click on the \"Connect\" button to establish a connection to the cluster.\n\n\u003cimg src=\"doc/gifs/AddConnection.gif\" height=\"80%\" width=\"80%\" alt=\"Add Connection to Cluster\" /\u003e\n\n\u003e **_NOTE:_** If you inform the \"Default Bucket\" field anc click on \"Test Connection\" we will run the SDK Doctor\n\u003e utility, which helps you to identify potential problems with your connection.\n\n### Connect, Disconnect or Delete a Cluster Connection\n\nRight-click on the connection to open the context menu. From the context menu, you will be able to choose between\noptions to Connect, Disconnect or Delete the Cluster.\n\n\u003cimg src=\"doc/gifs/ConnectDisconnectCluster.gif\" height=\"80%\" width=\"80%\" alt=\"Connect/Disconnect to Cluster\" /\u003e\n\n### Interact with Buckets and Scopes\n\nClick on the bucket to see the list of Scopes associated with that bucket. Open the context menu on bucket to undertake\nactions such as creating a new Scope, refreshing existing Scopes, or obtaining administrative information about the\nBucket.\n\n\u003cimg src=\"doc/gifs/InteractWithBucketsScopes.gif\" height=\"80%\" width=\"80%\" alt=\"Interact with Buckets and Scopes\" /\u003e\n\n### Interact with Collections and Indexes\n\nClick on Scope to list Collections and Indexes. Open context menu on Collection directory to create a new Collection or\nto refresh Collections.\n\n\u003cimg src=\"doc/gifs/InteractWithCollectionIndexes.gif\" height=\"80%\" width=\"80%\" alt=\"Interact with Collections and Indexes\" /\u003e\n\n### Interact with Documents\n\n1. Click on the desired Collection to list all the documents that have been stored within it.\n2. To open a specific document, click on it to view its details and make any necessary changes.\n3. If you need to create a new document or search for an existing one, you can open the context menu by right-clicking\n   on the Collection directory.\n4. Once you have made any necessary changes to a document, you can save it using the \"Ctrl + S\" or \"Cmd + S\" shortcut\n   keys.\n\n\u003cimg src=\"doc/gifs/InteractWithDocuments.gif\" height=\"80%\" width=\"80%\" alt=\"Interact with Documents\" /\u003e\n\n\u003e **_NOTE:_** If the document has already changed in the server by the time you modify and save it, we will show a\n\u003e message alerting you of that and asking if you want to keep your version or the server's one.\n\n### Plugin Log\n\nThe Couchbase JetBrains plugin offers a convenient logging feature that allows developers to easily log important\ninformation, debug messages, and error reports directly from the plugin interface. This feature streamlines the\ndevelopment process and helps developers track and analyze the plugin's behavior effectively.\n\n\u003cimg src=\"doc/screenshots/Logging.png\" height=\"80%\" width=\"80%\" alt=\"Logging\" /\u003e\n\n### Exporting the results of a SQL++ query\n\nYou can also export the results of a query to a file in either CSV or JSON format. This functionality simplifies data\nanalysis and sharing, allowing developers to easily save query results for further processing or to share data with\nother team members.\n\n\u003cimg src=\"doc/screenshots/QueryExport.png\" height=\"80%\" width=\"80%\" alt=\"Exporting the results of a N1QL query\" /\u003e\n\n### Autocomplete for SQL++ queries\n\nWith autocomplete, the Couchbase JetBrains plugin provides suggestions for SQL++ keywords and functions as developers\nwrite queries. This intelligent feature enhances coding efficiency by offering relevant options for completing SQL++\nstatements, helping users write accurate and syntactically correct queries while working with Couchbase databases.\n\n\u003cimg src=\"doc/screenshots/Autocomplete.png\" height=\"80%\" width=\"80%\" alt=\"Autocomplete for N1QL queries\" /\u003e\n\n### View Document Metadata\n\nRight-click on a document and access its metadata. The metadata is read-only, and any changes to it won't be persisted.\nThis functionality provides developers with a convenient way to inspect and modify document metadata during the\ndevelopment process without impacting the actual data stored in the Couchbase database.\n\n\u003cimg src=\"doc/screenshots/DocumentMetadata.png\" height=\"80%\" width=\"80%\" alt=\"View Document Metadata\" /\u003e\n\n### Connection Color\n\nYou can set custom colors for each Connection. This functionality proves beneficial when distinguishing between\ndifferent environments, such as Production and Development, to prevent accidental changes to critical data. Users can\neasily pick colors using a color picker, and the chosen color is then displayed as a small line in the tree or\nworkbench, providing a visual indicator of the active connection. If you switch to connect to another cluster that\ndoesn't have a color set, the interface reverts to its default appearance. This feature streamlines development\nworkflows and helps users maintain clarity and organization within the Couchbase plugin.\n\n\u003c!-- 3 images --\u003e\n\u003cimg src=\"doc/screenshots/ConnectionColor1.png\" height=\"80%\" width=\"80%\" alt=\"Connection Color\" /\u003e\n\n\u003cimg src=\"doc/screenshots/ConnectionColor2.png\" height=\"80%\" width=\"80%\" alt=\"Connection Color\" /\u003e\n\n\u003cimg src=\"doc/screenshots/ConnectionColor3.png\" height=\"80%\" width=\"80%\" alt=\"Connection Color\" /\u003e\n\n### Cluster Connection Statistics\n\nBy right-clicking on an active connection, developers can easily access and analyze statistics from the bucket and\ncluster, providing valuable insights into the performance and health of their Couchbase databases. This feature empowers\nusers to make informed decisions and optimize their database configurations for better overall efficiency and\nreliability.\n\n\u003c!-- 4 images: 1 top, 3 side by side --\u003e\n\n\u003cimg src=\"doc/screenshots/ClusterConnectionOverview.png\" height=\"80%\" width=\"80%\" alt=\"Cluster Connection Statistics\" /\u003e\n\n\u003cimg src=\"doc/screenshots/ClusterConnectionStatistics1.png\" height=\"80%\" width=\"80%\" alt=\"Cluster Connection Statistics\" /\u003e\n\n\u003cimg src=\"doc/screenshots/ClusterConnectionStatistics2.png\" height=\"80%\" width=\"80%\" alt=\"Cluster Connection Statistics\" /\u003e\n\n\u003cimg src=\"doc/screenshots/ClusterConnectionStatistics3.png\" height=\"80%\" width=\"80%\" alt=\"Cluster Connection Statistics\" /\u003e\n\n### View Index Statistics\n\nThe latest enhancement in the Couchbase JetBrains plugin enables users to access statistics for each index effortlessly.\nBy simply right-clicking on a specific index and selecting \"View Stats,\" developers can gain valuable insights into the\nindex's performance and usage. This feature streamlines the monitoring and optimization of indexes, helping users\nfine-tune their Couchbase database for improved query performance and overall efficiency.\n\n\u003cimg src=\"doc/screenshots/IndexStatistics1.png\" height=\"80%\" width=\"80%\" alt=\"View Index Statistics\" /\u003e\n\u003cimg src=\"doc/screenshots/IndexStatistics2.png\" height=\"80%\" width=\"80%\" alt=\"View Index Statistics\" /\u003e\n\n### Selective Query Execution\n\nWith the updated Couchbase JetBrains plugin, users gain the ability to select a specific query for execution when\ndealing with multiple queries. This functionality proves invaluable when working with complex tasks involving multiple\nqueries, allowing developers to choose and run a particular query with ease. This feature enhances productivity and\nsimplifies the query execution process, ensuring that developers can focus on the specific task at hand without any\nunnecessary steps or confusion.\n\n\u003cimg src=\"doc/screenshots/SelectiveQueryExecution.png\" height=\"80%\" width=\"80%\" alt=\"Selective Query Execution\" /\u003e\n\n### Read-Only Mode\n\nIf you are accessing sensible environments and are afraid of changing any data by mistake, the plugin also offers a\nread-only mode. Once activated, an eye icon appears next to the connection's name, indicating that the plugin is in\nread-only mode. In this mode, any actions that might modify the server, such as creating documents, adding scopes,\ncollections, indexes, importing data, etc., are hidden to prevent accidental changes to the database.\n\nFurthermore, the plugin performs validation checks, and if a user attempts to run a query with mutation operations while\nin read-only mode, a notification is triggered to alert the user about the read-only status. This read-only mode\nprovides an additional layer of security and peace of mind for developers, ensuring that sensitive data and critical\nconfigurations remain protected from accidental alterations while using the plugin.\n\n\u003c!-- 4 images --\u003e\n\u003cimg src=\"doc/screenshots/ReadOnlyMode1.png\" height=\"80%\" width=\"80%\" alt=\"Read-Only Mode\" /\u003e\n\u003cimg src=\"doc/screenshots/ReadOnlyMode2.png\" height=\"80%\" width=\"80%\" alt=\"Read-Only Mode\" /\u003e\n\u003cimg src=\"doc/screenshots/ReadOnlyMode3.png\" height=\"80%\" width=\"80%\" alt=\"Read-Only Mode\" /\u003e\n\u003cimg src=\"doc/screenshots/ReadOnlyMode4.png\" height=\"80%\" width=\"80%\" alt=\"Read-Only Mode\" /\u003e\n\n## License\n\nMIT. See individual files for details.\n\n## Support\n\nThis project is not officially supported by Couchbase, but it is actively maintained by Couchbase Employees. So if you\nfind any bugs/issues or would like to suggest anything, feel free to open an issue here on github.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcouchbase-ecosystem%2Fcouchbase_jetbrains_plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcouchbase-ecosystem%2Fcouchbase_jetbrains_plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcouchbase-ecosystem%2Fcouchbase_jetbrains_plugin/lists"}