Skip to content

Latest commit

 

History

History
83 lines (49 loc) · 3.75 KB

USER-GUIDE.md

File metadata and controls

83 lines (49 loc) · 3.75 KB
Raw

VSCode-Couchbase README

Welcome to the official Visual Studio Code extension for Couchbase!

This extension is designed to provide a seamless experience for Couchbase Server users who want to work within the popular Visual Studio Code editor.

Requirements

This extension requires OpenSSL to be installed on your system in order to install successfully.

For Windows:

For Debian or Ubuntu-based distros::

  • Run sudo apt-get install openssl

For Red Hat, CentOS or Fedora-based distros:

  • Run sudo dnf install openssl (on newer Fedora versions), OR sudo yum install openssl (on older Fedora/Red Hat/CentOS versions)

For Mac:

  • Run brew install openssl using Homebrew, or download the latest version of OpenSSL from https://www.openssl.org/source/ and follow the installation instructions.

⚠️ WARNING: DO NOT upgrade cmake-js to 7.x or it will break Windows builds. Please use 6.x instead.

Contributions & Community

This is not an officially supported Couchbase project, however we welcome contributions from the community via GitHub features such as the Issues tab.

You are also welcome to post on our forum or join our Discord server.

Please visit our CONTRIBUTING.md for information on contributing to this project.

Features

This Visual Studio Code extension has two features.

  1. A Database Browser

  2. Snippets

Database Browser

The purpose of this extension is to offer an uninterrupted and smooth experience for those who use Couchbase database and prefer using the widely-used Visual Studio Code editor.

This feature is giving the user freedom to work with couchbase cluster in Visual Studio.

It also allow you to create SQL++ Query Notebook which helps in composing and documenting SQL++ queries easily.

Snippets

These are useful when developing with supported Couchbase SDKs. These are:

Please visit SNIPPETS.md to see a list of our snippets with descriptions and documentation for each of them.

Authoring Snippets

For more information about creating snippets for a new language, or editing the current snippets, please see AUTHORING-SNIPPETS.md

How to Install from GitHub

Please visit the releases tab and download the most recent release. Once you've downloaded that:

  1. In Visual Studio Code navigate to the extensions tab, and click 'install from vsix',
  2. Select the vsix file that you just downloaded.

If you would like to package it yourself here, download the source code and run the following commands:

  1. npm install -g vsce,
  2. vsce package,
  3. In Visual Studio Code navigate to the extensions tab, and click 'install from vsix',
  4. Select the vsix file that you generated in step 2.

Feel free to read our GETTING-STARTED.md for more information.

License

Apache Software License Version 2. See individual files for details.