-
-
Notifications
You must be signed in to change notification settings - Fork 317
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
As a relative newcomer to VScode, I had a hard time understanding how SQLTools "worked" in the VScode ecosystem. I felt your documentation was missing a description of how to get started. (I have to compliment you - the actual installation process is _flawless_, once I learned where to look.) Here's an introductory paragraph that would have been a useful hint for me. Thanks!
- Loading branch information
1 parent
6fd36cd
commit 543cc5d
Showing
1 changed file
with
16 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -40,6 +40,21 @@ Connects to MySQL, PostgreSQL, Microsoft SQL Server and many more... | |
|
||
Find out more in the documentation [here](http://vscode-sqltools.mteixeira.dev/#features). | ||
|
||
## Getting Started | ||
|
||
SQLTools is a set of VScode extensions that connect to, query, and display results from a SQL database manager. | ||
(Supported databases are listed below.) | ||
|
||
The installation process is straightforward: Open VScode, go to the Marketplace | ||
and install [SQLTools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools&ssr=false#review-details). | ||
Then install a _driver_ for your database(s), (for example, | ||
[MySQL/MariaDB/TiDB](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools-driver-mysql)) | ||
Finally, create a _connection_ to your database. | ||
You can then open and query it from within VScode. | ||
|
||
Check out the [Tutorial on Youtube](https://www.youtube.com/watch?v=wzdCpJY6Y4c) | ||
that visually walks through the steps. | ||
|
||
<DriversSection /> | ||
|
||
## Contributing | ||
|
@@ -60,4 +75,4 @@ If you need help sooner, get in touch with the maintainers directly – we might | |
|
||
George James Software has been providing innovative software solutions for over 35 years. We pride ourselves on the quality and maintainability of our code and we have built a number of tools to help developers achieve the same with their work. These are available as VS Code extensions [here](https://marketplace.visualstudio.com/publishers/georgejames). | ||
|
||
We also help other developers to build their own extensions. If there is a tool you need building please get in touch with us at [[email protected]](mailto:[email protected]). | ||
We also help other developers to build their own extensions. If there is a tool you need building please get in touch with us at [[email protected]](mailto:[email protected]). |