Edit Data Service (#241)

This is a very large change. I'll try to outline what's going on.

1. This adds the **EditDataService** which manages editing **Sessions**.
    1. Each session has a **ResultSet** (from the QueryExecutionService) which has the rows of the table and basic metadata about the columns 
    2. Each session also has an **IEditTableMetadata** implementation which is derived from SMO metadata which provides more in-depth and trustworthy data about the table than SqlClient alone can.
    3. Each session holds a list of **RowEditBase** abstract class implementations
        1. **RowUpdate** - Update cells in a row (generates `UPDATE` statement)
        2. **RowDelete** - Delete an entire row (generates `DELETE` statement)
        3. **RowCreate** - Add a new row (generates `INSERT INTO` statement)
    4. Row edits have a collection of **CellUpdates** that hold updates for individual cells (except for RowDelete)
        1. Cell updates are generated from text
     5. RowEditBase offers some baseline functionality
        1. Generation of `WHERE` clauses (which can be parameterized)
        2. Validation of whether a column can be updated
2. New API Actions
    1. edit/initialize - Queries for the contents of a table/view, builds SMO metadata, sets up a session
    2. edit/createRow - Adds a new RowCreate to the Session
    3. edit/deleteRow - Adds a new RowDelete to the Session
    4. edit/updateCell - Adds a CellUpdate to a RowCreate or RowUpdate in the Session
    5. edit/revertRow - Removes a RowCreate, RowDelete, or RowUpdate from the Session
    6. edit/script - Generates a script for the changes in the Session and stores to disk
    7. edit/dispose - Removes a Session and releases the query
3. Smaller updates (unit test mock improvements, tweaks to query execution service)

**There are more updates planned -- this is just to get eyeballs on the main body of code**

* Initial stubs for edit data service

* Stubbing out update management code

* Adding rudimentary dispose request

* More stubbing out of update row code

* Adding complete edit command contracts, stubbing out request handlers

* Adding basic implementation of get script

* More in progress work to implement base of row edits

* More in progress work to implement base of row edits

* Adding string => object conversion logic and various cleanup

* Adding a formatter for using values in scripts

* Splitting IMessageSender into IEventSender and IRequestSender

* Adding inter-service method for executing queries

* Adding inter-service method for disposing of a query

* Changing edit contract to include the object to edit

* Fully fleshing out edit session initialization

* Generation of delete scripts is working

* Adding scripter for update statements

* Adding scripting functionality for INSERT statements

* Insert, Update, and Delete all working with SMO metadata

* Polishing for SqlScriptFormatter

* Unit tests and reworked byte[] conversion

* Replacing the awful and inflexible Dictionary<string, string>[][] with a much better test data set class

* Fixing syntax error in generated UPDATE statements

* Adding unit tests for RowCreate

* Adding tests for the row edit base class

* Adding row delete tests

* Adding RowUpdate tests, validation for number of key columns

* Adding tests for the unit class

* Adding get script tests for the session

* Service integration tests, except initialization tests

* Service integration tests, except initialization tests

* Adding messages to sr.strings

* Adding messages to sr.strings

* Fixing broken unit tests

* Adding factory pattern for SMO metadata provider

* Copyright and other comments

* Addressing first round of comments

* Refactoring EditDataService to have a single method for handling
session-dependent operations
* Refactoring Edit Data contracts to inherit from a Session and Row
operation params base class
* Copyright additions
* Small tweak to strings
* Updated unit tests to test the refactors

* More revisions as per pull request comments
This commit is contained in:
Benjamin Russell
2017-02-22 17:32:57 -08:00
committed by GitHub
parent 2b15890b00
commit 795eba3da6
49 changed files with 4370 additions and 137 deletions

View File

@@ -485,6 +485,134 @@ namespace Microsoft.SqlTools.ServiceLayer
}
}
public static string EditDataSessionNotFound
{
get
{
return Keys.GetString(Keys.EditDataSessionNotFound);
}
}
public static string EditDataQueryNotCompleted
{
get
{
return Keys.GetString(Keys.EditDataQueryNotCompleted);
}
}
public static string EditDataQueryImproperResultSets
{
get
{
return Keys.GetString(Keys.EditDataQueryImproperResultSets);
}
}
public static string EditDataFailedAddRow
{
get
{
return Keys.GetString(Keys.EditDataFailedAddRow);
}
}
public static string EditDataRowOutOfRange
{
get
{
return Keys.GetString(Keys.EditDataRowOutOfRange);
}
}
public static string EditDataUpdatePending
{
get
{
return Keys.GetString(Keys.EditDataUpdatePending);
}
}
public static string EditDataUpdateNotPending
{
get
{
return Keys.GetString(Keys.EditDataUpdateNotPending);
}
}
public static string EditDataObjectMetadataNotFound
{
get
{
return Keys.GetString(Keys.EditDataObjectMetadataNotFound);
}
}
public static string EditDataInvalidFormatBinary
{
get
{
return Keys.GetString(Keys.EditDataInvalidFormatBinary);
}
}
public static string EditDataInvalidFormatBoolean
{
get
{
return Keys.GetString(Keys.EditDataInvalidFormatBoolean);
}
}
public static string EditDataCreateScriptMissingValue
{
get
{
return Keys.GetString(Keys.EditDataCreateScriptMissingValue);
}
}
public static string EditDataDeleteSetCell
{
get
{
return Keys.GetString(Keys.EditDataDeleteSetCell);
}
}
public static string EditDataColumnIdOutOfRange
{
get
{
return Keys.GetString(Keys.EditDataColumnIdOutOfRange);
}
}
public static string EditDataColumnCannotBeEdited
{
get
{
return Keys.GetString(Keys.EditDataColumnCannotBeEdited);
}
}
public static string EditDataColumnNoKeyColumns
{
get
{
return Keys.GetString(Keys.EditDataColumnNoKeyColumns);
}
}
public static string EditDataScriptFilePathNull
{
get
{
return Keys.GetString(Keys.EditDataScriptFilePathNull);
}
}
public static string EE_BatchSqlMessageNoProcedureInfo
{
get
@@ -790,6 +918,11 @@ namespace Microsoft.SqlTools.ServiceLayer
return Keys.GetString(Keys.WorkspaceServiceBufferPositionOutOfOrder, sLine, sCol, eLine, eCol);
}
public static string EditDataUnsupportedObjectType(string typeName)
{
return Keys.GetString(Keys.EditDataUnsupportedObjectType, typeName);
}
[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
public class Keys
{
@@ -1008,6 +1141,57 @@ namespace Microsoft.SqlTools.ServiceLayer
public const string WorkspaceServiceBufferPositionOutOfOrder = "WorkspaceServiceBufferPositionOutOfOrder";
public const string EditDataSessionNotFound = "EditDataSessionNotFound";
public const string EditDataUnsupportedObjectType = "EditDataUnsupportedObjectType";
public const string EditDataQueryNotCompleted = "EditDataQueryNotCompleted";
public const string EditDataQueryImproperResultSets = "EditDataQueryImproperResultSets";
public const string EditDataFailedAddRow = "EditDataFailedAddRow";
public const string EditDataRowOutOfRange = "EditDataRowOutOfRange";
public const string EditDataUpdatePending = "EditDataUpdatePending";
public const string EditDataUpdateNotPending = "EditDataUpdateNotPending";
public const string EditDataObjectMetadataNotFound = "EditDataObjectMetadataNotFound";
public const string EditDataInvalidFormatBinary = "EditDataInvalidFormatBinary";
public const string EditDataInvalidFormatBoolean = "EditDataInvalidFormatBoolean";
public const string EditDataCreateScriptMissingValue = "EditDataCreateScriptMissingValue";
public const string EditDataDeleteSetCell = "EditDataDeleteSetCell";
public const string EditDataColumnIdOutOfRange = "EditDataColumnIdOutOfRange";
public const string EditDataColumnCannotBeEdited = "EditDataColumnCannotBeEdited";
public const string EditDataColumnNoKeyColumns = "EditDataColumnNoKeyColumns";
public const string EditDataScriptFilePathNull = "EditDataScriptFilePathNull";
public const string EE_BatchSqlMessageNoProcedureInfo = "EE_BatchSqlMessageNoProcedureInfo";