ckaczor/sqltoolsservice
1
0
Fork 0
mirror of https://github.com/ckaczor/sqltoolsservice.git synced 2026-02-09 17:52:35 -05:00
Code Issues Packages Projects Releases Wiki Activity

Edit Data Service (#241)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

86
src/Microsoft.SqlTools.ServiceLayer/Localization/sr.xlf
View File

@@ -509,6 +509,92 @@
<target state="new">Replacement of an empty string by an empty string.</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataSessionNotFound">
<source>Edit session does not exist.</source>
<target state="new">Edit session does not exist.</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataQueryNotCompleted">
<source>Query has not completed execution</source>
<target state="new">Query has not completed execution</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataQueryImproperResultSets">
<source>Query did not generate exactly one result set</source>
<target state="new">Query did not generate exactly one result set</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataFailedAddRow">
<source>Failed to add new row to update cache</source>
<target state="new">Failed to add new row to update cache</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataRowOutOfRange">
<source>Given row ID is outside the range of rows in the edit cache</source>
<target state="new">Given row ID is outside the range of rows in the edit cache</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataUpdatePending">
<source>An update is already pending for this row and must be reverted first</source>
<target state="new">An update is already pending for this row and must be reverted first</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataUpdateNotPending">
<source>Given row ID does not have pending updated</source>
<target state="new">Given row ID does not have pending updated</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataObjectMetadataNotFound">
<source>Table or view metadata could not be found</source>
<target state="new">Table or view metadata could not be found</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataInvalidFormatBinary">
<source>Invalid format for binary column</source>
<target state="new">Invalid format for binary column</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataInvalidFormatBoolean">
<source>Allowed values for boolean columns are 0, 1, "true", or "false"</source>
<target state="new">Boolean columns must be numeric 1 or 0, or string true or false</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataCreateScriptMissingValue">
<source>A required cell value is missing</source>
<target state="new">A required cell value is missing</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataDeleteSetCell">
<source>A delete is pending for this row, a cell update cannot be applied.</source>
<target state="new">A delete is pending for this row, a cell update cannot be applied.</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataColumnIdOutOfRange">
<source>Column ID must be in the range of columns for the query</source>
<target state="new">Column ID must be in the range of columns for the query</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataColumnCannotBeEdited">
<source>Column cannot be edited</source>
<target state="new">Column cannot be edited</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataColumnNoKeyColumns">
<source>No key columns were found</source>
<target state="new">No key columns were found</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataScriptFilePathNull">
<source>An output filename must be provided</source>
<target state="new">An output filename must be provided</target>
<note></note>
</trans-unit>
<trans-unit id="EditDataUnsupportedObjectType">
<source>Database object {0} cannot be used for editing.</source>
<target state="new">Database object {0} cannot be used for editing.</target>
<note>.
Parameters: 0 - typeName (string) </note>
</trans-unit>
</body>
</file>
</xliff>