|
5 | 5 | "credentials": { |
6 | 6 | "fields": { |
7 | 7 | "server": { |
8 | | - "label": "Server (you can use 'host\\\\instance' to connect to named instance)", |
| 8 | + "label": "Server", |
9 | 9 | "required": true, |
10 | 10 | "viewClass": "TextFieldView", |
11 | | - "placeholder": "localhost" |
12 | | - }, |
13 | | - "port": { |
14 | | - "label": "Port (don't set when connecting to named instance)", |
15 | | - "required": false, |
16 | | - "viewClass": "TextFieldView", |
17 | | - "placeholder": "1433" |
| 11 | + "placeholder": "localhost", |
| 12 | + "help": { |
| 13 | + "description": "Server to connect. You can use 'host\\\\instance' to connect to named instance." |
| 14 | + } |
18 | 15 | }, |
19 | | - "database": { |
| 16 | + "database": { |
20 | 17 | "label": "Database Name", |
21 | 18 | "required": true, |
22 | 19 | "viewClass": "TextFieldView", |
23 | | - "placeholder": "database" |
24 | | - }, |
25 | | - "encrypt": { |
26 | | - "label": "Encrypt (check this option if you're using Windows Azure)", |
27 | | - "viewClass": "CheckBoxView" |
28 | | - }, |
29 | | - "domain": { |
30 | | - "label": "Domain (driver will connect to SQL Server using domain login)", |
31 | | - "required": false, |
32 | | - "viewClass": "TextFieldView", |
33 | | - "placeholder": "domain" |
| 20 | + "placeholder": "database", |
| 21 | + "help": { |
| 22 | + "description": "Database to connect. Default is dependent on server configuration." |
| 23 | + } |
34 | 24 | }, |
35 | | - "username": { |
| 25 | + "username": { |
36 | 26 | "label": "Username", |
37 | 27 | "required": true, |
38 | 28 | "viewClass": "TextFieldView", |
39 | | - "placeholder": "username" |
| 29 | + "placeholder": "username", |
| 30 | + "help": { |
| 31 | + "description": "User name to use for authentication with the database." |
| 32 | + } |
40 | 33 | }, |
41 | 34 | "password": { |
42 | 35 | "label": "Password", |
43 | 36 | "required": true, |
44 | 37 | "viewClass": "PasswordFieldView", |
45 | | - "placeholder": "password" |
| 38 | + "placeholder": "password", |
| 39 | + "help": { |
| 40 | + "description": "Password to use for authentication with the database." |
| 41 | + } |
| 42 | + }, |
| 43 | + "port": { |
| 44 | + "label": "Port", |
| 45 | + "required": false, |
| 46 | + "viewClass": "TextFieldView", |
| 47 | + "placeholder": "1433", |
| 48 | + "help": { |
| 49 | + "description": "Port to connect. If not provided default port 1433 is used. Don't set when connecting to named instance." |
| 50 | + } |
| 51 | + }, |
| 52 | + "domain": { |
| 53 | + "label": "Domain", |
| 54 | + "required": false, |
| 55 | + "viewClass": "TextFieldView", |
| 56 | + "placeholder": "domain", |
| 57 | + "help": { |
| 58 | + "description": "If domain is provided, the connection to SQL Server will be done using domain login." |
| 59 | + } |
| 60 | + }, |
| 61 | + "encrypt": { |
| 62 | + "label": "Encrypt", |
| 63 | + "viewClass": "CheckBoxView", |
| 64 | + "help": { |
| 65 | + "description": "Enable this option if you're using Windows Azure" |
| 66 | + } |
46 | 67 | } |
47 | 68 | } |
48 | 69 | }, |
49 | 70 | "actions": { |
50 | 71 | "insert": { |
51 | 72 | "title": "INSERT/UPDATE/DELETE", |
52 | | - "description": "Executes a single SQL statement that causes database data update and returns a number of affected records, like INSERT, UPDATE or DELETE", |
53 | 73 | "main": "./lib/actions/insert.js", |
| 74 | + "help": { |
| 75 | + "description": "Executes a single SQL statement that causes database data update and returns a number of affected records, like INSERT, UPDATE or DELETE", |
| 76 | + "link": "/components/mssql/index.html#insertdeleteupdate-action" |
| 77 | + }, |
54 | 78 | "fields": { |
55 | 79 | "query": { |
56 | 80 | "label": "SQL Query", |
57 | 81 | "required": true, |
58 | 82 | "viewClass": "TextAreaWithNoteView", |
59 | 83 | "placeholder": "INSERT INTO films (code,title,kind) VALUES (@code:number,@title:string,@kind:string)", |
60 | | - "note": "You can use parameters of message body as <i>@value:number</i> and type is <i>:type</i>" |
| 84 | + "help": { |
| 85 | + "description": "SQL query to execute. You can use parameters of message body as '@value:number' and type is ':type'" |
| 86 | + } |
61 | 87 | } |
62 | 88 | }, |
63 | 89 | "dynamicMetadata": true |
64 | 90 | }, |
65 | 91 | "selectAction": { |
66 | 92 | "title": "SELECT", |
67 | | - "description": "Executes a SELECT statement that fetches potentially multiple database rows from the database", |
68 | 93 | "main": "./lib/actions/select.js", |
| 94 | + "help": { |
| 95 | + "description": "Executes a SELECT statement that fetches potentially multiple database rows from the database", |
| 96 | + "link": "/components/mssql/index.html#select-action" |
| 97 | + }, |
69 | 98 | "metadata": { |
70 | 99 | "in": { |
71 | 100 | "type": "object", |
72 | 101 | "properties": { |
73 | 102 | "query": { |
74 | 103 | "type": "string", |
75 | | - "title": "SQL Query", |
76 | | - "required": true |
| 104 | + "title": "SQL SELECT Statement", |
| 105 | + "required": true, |
| 106 | + "description": "Executes a SELECT statement that fetches potentially multiple database rows from the database" |
77 | 107 | } |
78 | 108 | } |
79 | 109 | } |
|
82 | 112 | }, |
83 | 113 | "triggers": { |
84 | 114 | "selectTrigger": { |
85 | | - "title": "SELECT", |
86 | | - "description": "Executes a SELECT statement that fetches potentially multiple database rows from the database", |
| 115 | + "title": "SQL SELECT Statement", |
87 | 116 | "main": "./lib/actions/select.js", |
88 | 117 | "type": "polling", |
| 118 | + "help": { |
| 119 | + "description": "Executes a SELECT statement that fetches potentially multiple database rows from the database", |
| 120 | + "link": "/components/mssql/index.html#select-trigger-and-action" |
| 121 | + }, |
89 | 122 | "fields": { |
90 | 123 | "query": { |
91 | | - "label": "SQL Query", |
| 124 | + "label": "SQL SELECT Statement", |
92 | 125 | "required": true, |
93 | 126 | "viewClass": "TextAreaWithNoteView", |
94 | | - "placeholder": "INSERT INTO films (code,title,kind) VALUES (@code:number,@title:string,@kind:string)", |
95 | | - "note": "You can use parameters of message body as <i>@value:number</i> and type is <i>:type</i>" |
| 127 | + "placeholder": "SELECT * FROM Employee WHERE EmpID = 322", |
| 128 | + "help": { |
| 129 | + "description": "SQL SELECT Statement to execute" |
| 130 | + } |
96 | 131 | } |
97 | 132 | }, |
98 | 133 | "metadata": { |
|
0 commit comments