[Kusto] Update ReadMe file (#12116)

* Add CodeQL Analysis workflow (#10195)

* Add CodeQL Analysis workflow

* Fix path

* [Kusto] Update readme

* changed click to select

* Add Animated gifs and some text updtes

* add link

* change in media format syntax

* Removed peek definitions

* removed all machine learning refs

* removed en-us

* rename media to images

* removed gifs

* added back peek definitions

* changed media to images

* rename folder again and remove azuredatastudio repo link

* help whitespace identions

* renamed media files

* change image format text

* removed gifs

* add gifs back

* edit gulpfile.hygiene.js file to add gifs

* fixed image

Co-authored-by: Justin Hutchings <jhutchings1@users.noreply.github.com>
This commit is contained in:
Mark Ghanayem
2020-09-08 11:50:08 -05:00
committed by GitHub
parent 3134449b38
commit 68709c02fe
4 changed files with 42 additions and 19 deletions

View File

@@ -96,6 +96,7 @@ const indentationFilter = [
'!**/*.dockerfile',
'!extensions/markdown-language-features/media/*.js',
// {{SQL CARBON EDIT}}
'!**/*.gif',
'!build/actions/**/*.js',
'!**/*.{xlf,docx,sql,vsix,bacpac,ipynb,jpg}',
'!extensions/mssql/sqltoolsservice/**',

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.9 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 MiB

View File

@@ -1,33 +1,55 @@
# Kusto extension for Azure Data Studio (preview)
# Kusto (KQL) extension for Azure Data Studio (Preview)
Connect and query Azure Data Explorer (Kusto) clusters and databases with Azure Data Studio, a modern data editor available for Linux, MacOS, and Windows. This (preview) extension enables you to interact with Postgres using Azure Data Studio features like:
Connect and query Azure Data Explorer (Kusto) clusters and databases with Azure Data Studio, a modern data editor available for Linux, MacOS, and Windows. This extension enables you to interact with Kusto using Azure Data Studio features like:
* Connect to Azure Data Explorer anywhere
* Searchable object explorer view for database objects
* Query authoring and editing with Intellisense and syntax highlighting
* View query results and save to csv, JSON, xml, or Excel
* Integrated terminal for Bash, PowerShell, and cmd.exe
* Source control integration with Git
* Server groups for organizing connections
* Customizable keyboard shortcuts, multi-tab support, color theme options
- Connect to Azure Data Explorer anywhere.
- Searchable object explorer view for database objects.
- Query authoring and editing with Intellisense and syntax highlighting.
- Create a notebook with Kusto.
- View query results and save to CSV, JSON, XML, Excel, or as a chart.
For more information, see the [Kusto extension for Azure Data Studio documentation](https://go.microsoft.com/fwlink/?linkid=2129918).
## Connect to an Azure Data Explorer cluster
You can connect to an Azure Data Explorer cluster with Azure Data Studio.
Select **New Connection** and choose **Kusto** for the **Connection Type**.
Once connected to a cluster, you can start writing a KQL query, run it and a view the results to save it to CSV, JSON, XML, Excel, or as a chart as shown below.
![KQL query in Azure Data Studio](media/kusto-readme-query.gif)
For more information, see [how to create a notebook with the Kusto extension](https://go.microsoft.com/fwlink/?linkid=2129920).
## Create notebooks using the Kusto Kernel
You can run Kusto in a notebook with Azure Data Studio.
Select on **Create notebook** to create a new notebook in Azure Data Studio.
![Kusto notebook in Azure Data Studio](media/kusto-readme-notebook.gif)
For more information, see [how to create a notebook with the Kusto extension](https://go.microsoft.com/fwlink/?linkid=2129920).
## Contributing to the Extension
This extension lives in the azuredatastudio repo and follows the same guidelines for contribution. If you are interested in fixing issues and contributing directly to the code base,
please see the document [How to Contribute](https://github.com/Microsoft/azuredatastudio/wiki/How-to-Contribute), which covers the following:
* [How to build and run from source](https://github.com/Microsoft/azuredatastudio/wiki/How-to-Contribute#Build-and-Run-From-Source)
* [The development workflow, including debugging and running tests](https://github.com/Microsoft/azuredatastudio/wiki/How-to-Contribute#development-workflow)
* [Submitting pull requests](https://github.com/Microsoft/azuredatastudio/wiki/How-to-Contribute#pull-requests)
This extension lives in the [azuredatastudio repo](https://github.com/microsoft/azuredatastudio) and follows the same guidelines for contribution. If you are interested in fixing issues and contributing directly to the code base, see the document [How to Contribute](https://github.com/Microsoft/azuredatastudio/wiki/How-to-Contribute), which covers the following:
- [How to build and run from source](https://github.com/Microsoft/azuredatastudio/wiki/How-to-Contribute#Build-and-Run-From-Source)
- [The development workflow, including debugging and running tests](https://github.com/Microsoft/azuredatastudio/wiki/How-to-Contribute#development-workflow)
- [Submitting pull requests](https://github.com/Microsoft/azuredatastudio/wiki/How-to-Contribute#pull-requests)
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Privacy Statement
The [Microsoft Enterprise and Developer Privacy Statement](https://privacy.microsoft.com/en-us/privacystatement) describes the privacy statement of this software.
The [Microsoft Enterprise and Developer Privacy Statement](https://privacy.microsoft.com/privacystatement) describes the privacy statement of this software.
## License
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the [Source EULA](https://raw.githubusercontent.com/Microsoft/azuredatastudio/main/LICENSE.txt)
[quickstart]: https://docs.microsoft.com/sql/azure-data-studio/quickstart-postgres
Licensed under the [Source EULA](https://raw.githubusercontent.com/Microsoft/azuredatastudio/main/LICENSE.txt).