Skip to content

Commit fc336e3

Browse files
committed
add faq
1 parent 3b5eb74 commit fc336e3

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ Compare Difference In T-SQL Queries at Runtime
44
![CI Status](https://travis-ci.org/llouislu/tsql-diff.svg?branch=master) ![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)
55

66
## Install
7-
1. Go to [release](https://github.com/llouislu/tsql-diff/releases) and download the latest **Release** version.
8-
2. execute install.sql in your target database.
7+
1. Download [tSQLt](http://tsqlt.org/download/tsqlt/) and follow the install [guide](https://tsqlt.org/user-guide/quick-start/)
8+
2. Go to [release](https://github.com/llouislu/tsql-diff/releases) and download the latest **Release** version.
9+
3. execute install.sql in your target database.
910

1011
## Uninstall
1112
Execute this stored procedure.
@@ -72,7 +73,7 @@ EXEC @status_code = Diff.Compare 'path/to/query1.sql', 'path/to/query2.sql';
7273
Diff.CompareFolder
7374
@FolderPath NVARCHAR(1024) = N'/root/data/t',
7475
-- location of a folder where T-SQL files are stored
75-
-- accepts both blackslashes on Windows and forwardslashes on *nix
76+
-- accepts filepaths on Windows and Linux
7677
@ModifierName NVARCHAR(32) = N'Model',
7778
-- a filename suffix in identifying the current file as an anchor/master/standard/expected query
7879
-- e.g. In the filename 'q01Model.sql', 'Model' indicates the file is marked as correct.
@@ -96,10 +97,14 @@ exec Diff.ComapreFolder @FolderPath='/test', @ModifierName='Model'
9697
| 8 | column names not matched |
9798
| 16 | data row not matched |
9899

100+
### FAQ
101+
Q: Why `Diff.CompareFolder` finds nothing in a folder on Windows?
102+
A: Please grant read access of the folder to the user group `Authenticated Users`.
103+
99104
### Limitations
100105

101-
- T-SQL Diff only receives the first `SELECT` statement as input to compare.
106+
- T-SQL Diff only receives the first `SELECT` statement as input to compare
102107

103108
- `WITH` statements (e.g. cte) in `SELECT` are not supported
104109

105-
- Custom datatypes defined by CLR are not supported
110+
- Custom datatypes defined by CLR are not supported

0 commit comments

Comments
 (0)