ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-02-16 10:58:30 -05:00
Code Issues Packages Projects Releases Wiki Activity

More documentation updates. (#205)

Browse Source 
* Add additional documentation.

* More docs updates.

* Update docs.  Add building info.
This commit is contained in:
Karl Burtram
2016-12-22 18:44:45 -08:00
committed by GitHub
parent d5f19031f2
commit 323374d123
6 changed files with 332 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/design/index.md
View File

@@ -15,6 +15,22 @@ The SQL Tools Service is built on top of the SMO SDK for .Net Core and System.Da
to provide rich SQL Server support that runs on Windows, Mac OS, and Linux operating systems. The service can work with on-prem SQL Server,
SQL DB, and Azure SQL DW instances.
## Message Dispatcher
The JSON-RPC mechanism is build on a message dispatcher. Messages are read from stdio and serialized\deserialized
using JSON.Net. Message handlers are registered with the dispatcher. Ass the messages are processed by
the dispatcher queue they are routed to any registered handlers. The dispatch queue processes messages
serially.
<img src='../images/msgdispatch.png' width='650px' />
The below sequence diagram show an example of how the language service may process a error checking diagnostics
workflow. In this example the editor hosts a language service client that responds to user initiated editing events.
The user actions are translated into a sequence of request\response pairs and one-way event notifications.
Messages can be initiated from either the server or the client.
<img src='../images/msgdispatchexample.png' width='800px' />
## Language Service
The SQL Tools Service implements the [language service protocol](https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md)
implemented by VS Code. This includes support for the following operations.
@@ -37,21 +53,13 @@ The binding queue is implemented in @Microsoft.SqlTools.ServiceLayer.LanguageSer
<img src='../images/connected_bind.png' width='800px' />
## Message Dispatcher
## Connection Management
The Connection Management component provides functionality to establish connections to SQL Server instances.
A connection is required to work with many language service and query execution APIs.
The JSON-RPC mechanism is build on a message dispatcher. Messages are read from stdio and serialized\deserialized
using JSON.Net. Message handlers are registered with the dispatcher. Ass the messages are processed by
the dispatcher queue they are routed to any registered handlers. The dispatch queue processes messages
serially.
<img src='../images/msgdispatch.png' width='650px' />
The below sequence diagram show an example of how the language service may process a error checking diagnostics
workflow. In this example the editor hosts a language service client that responds to user initiated editing events.
The user actions are translated into a sequence of request\response pairs and one-way event notifications.
Messages can be initiated from either the server or the client.
<img src='../images/msgdispatchexample.png' width='800px' />
@Microsoft.SqlTools.ServiceLayer.Connection.ConnectionService
([src link](https://github.com/Microsoft/sqltoolsservice/blob/dev/src/Microsoft.SqlTools.ServiceLayer/Connection/ConnectionService.cs))
is the class that implements the connection management protocol.
## Query Execution
The Query Execution component provides the ability to execute SQL scripts against SQL Server instances.
@@ -61,4 +69,3 @@ and a file-backed cache for large resultsets.
@Microsoft.SqlTools.ServiceLayer.QueryExecution.QueryExecutionService
([src link](https://github.com/Microsoft/sqltoolsservice/blob/dev/src/Microsoft.SqlTools.ServiceLayer/QueryExecution/QueryExecutionService.cs))
is the class that implements the query execution protocol.