{"id":13021,"date":"2022-04-07T15:05:37","date_gmt":"2022-04-07T22:05:37","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=13021"},"modified":"2023-05-19T04:25:47","modified_gmt":"2023-05-19T11:25:47","slug":"introducing-visual-studio-code-plugin-for-couchbase-mobile","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/introducing-visual-studio-code-plugin-for-couchbase-mobile\/","title":{"rendered":"Introducing Visual Studio Code Plugin for Couchbase Mobile"},"content":{"rendered":"

Couchbase Lite now has an exciting new developer tool to announce. Developers need good tools, just like any other profession. The quality of the tools directly impacts the efficiency and quality of development work. Many have come and gone over the years, but there is one tool currently standing out in the field: <\/span>Visual Studio Code<\/span><\/a>.\u00a0<\/span><\/p>\n

“VSCode” extends the universal text editor and syntax highlighting with customized working environments crafted to your needs. As with all things customizable, plugins have begun to emerge, showcasing that this humble text editor has far more power than merely editing text. Graphics can be previewed, network connections can be made, and even binary files can be opened and examined.<\/span><\/p>\n

For this reason, it is my pleasure to announce that Couchbase has released a plugin for Visual Studio Code that allows users to inspect Couchbase Lite databases.<\/b><\/p>\n

Download the VSCode Plugin for Couchbase Lite from the Visual Studio Code Extensions <\/span>marketplace<\/span><\/a> and read on to learn more.<\/p>\n

\"VSCode<\/a><\/p>\n

This is so exciting because it is the first time that this examination is possible in such a rich, graphical, cross-platform setting. If you are curious about the contents of the <\/span>database, this is now the easiest way to explore it. While currently using a prerelease number, the plugin is based on and uses a stable tested build of the <\/span>Couchbase Lite<\/span><\/a> library underneath to provide functionality. Let’s have a look at some of the things it can do.<\/span><\/p>\n

Open a Couchbase Lite database in Visual Studio Code<\/span><\/h2>\n

Of course, it can clearly list all the documents contained within a given database. This will probably be the first thing noticed when opening a database:<\/span><\/p>\n

\"Open<\/a>\"Browse<\/a><\/p>\n

<\/h3>\n

Beyond that, if you are wondering about the things that are possible with the tool, then it is best summarized as <\/span>CRUD<\/span><\/a> operations.\u00a0<\/span><\/p>\n

As with the Couchbase Lite SDK, if you open a database with the Visual Studio Code plugin, your database will be automatically upgraded<\/em> to the latest format and will no longer open in previous SDK versions. If this will cause issues, then make a copy of the database folder before opening it with the plugin.<\/span><\/p>\n

CRUD operations on Couchbase Lite documents<\/span><\/h2>\n

For example, you can read the contents of a document as JSON:<\/span><\/p>\n

\"Read<\/a><\/p>\n

If needed, you can edit the document you just opened and save it back:<\/span><\/p>\n

\"Edit<\/a><\/p>\n

Querying a Couchbase Mobile database<\/span>
\n<\/a><\/h2>\n

If you want to run some queries on your database, that is also possible. Right click on a database and select the option to create a new query and then once you have written the query to your liking, use the command palette (or shortcut Ctrl + Shift + Q) to run it:<\/span><\/p>\n

\"Execute<\/a><\/p>\n

Summary<\/span><\/h2>\n

These are simple actions but provide a lot of power to the user! This plugin is still new and has a chance to expand in new directions, but I believe this is an excellent introduction to Couchbase Lite databases outside of the context of Couchbase Lite itself.\u00a0<\/span><\/p>\n

The plugin is open source and can be found <\/span>on GitHub<\/span><\/a>. It is written in Typescript and leverages the <\/span>Couchbase Lite C<\/span><\/a> SDK, launched with <\/span>Couchbase Mobile 3<\/span><\/a>. The build instructions require downloading the C library but other than that, they are very straightforward. Inside the repo there is the plugin itself, along with the TypeScript bindings used to call into the C library.\u00a0<\/span><\/p>\n

More Resources<\/span><\/h2>\n