Skip to content

Commit 470658e

Browse files
committed
Add some details.
1 parent 526bafd commit 470658e

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,28 @@ SELECT $(Columns) FROM Foo;
6868

6969
```sql
7070
:setvar Columns Name -- this works
71-
:setvar Columns "Id, Name" -- this also works
71+
:setvar Columns "Id, Name" -- also works; required if value contains space
7272
```
7373

7474
### `:r` — include a file
7575

7676
```sql
7777
:r OtherFile.sql -- this works
78-
:r "Other File.sql" -- this also works
78+
:r "Other File.sql" -- also works; required if path contains space
7979
```
8080

81+
### Notes
82+
83+
Preprocessor directives are case-insensitive.
84+
85+
A `GO` batch separator must appear the the beginning of a line.
86+
No other content may appear on that line.
87+
88+
A `:setvar` or `:r` directive must appear at the beginning of a line.
89+
An optional line comment may follow the directive.
90+
91+
`$(…)` may appear anywhere, including inside other preprocessor directives.
92+
8193
<!--
8294
Copyright 2022 Jeffrey Sharp
8395

0 commit comments

Comments
 (0)