Documentation Source Text

Check-in [8b3cf7e669]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Fix the documentation of PRAGMA index_info to omit the three extra files that were reverted. Improve the documentation of PRAGMA index_list to detail the output fields.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: 8b3cf7e669e90e4e9fbe98c472a216ea8bf4f66c
User & Date: drh 2015-03-05 15:35:14
Context
2015-03-05
21:00
Add a couple of details to fts5.in. check-in: 23989471bd user: dan tags: trunk
15:35
Fix the documentation of PRAGMA index_info to omit the three extra files that were reverted. Improve the documentation of PRAGMA index_list to detail the output fields. check-in: 8b3cf7e669 user: drh tags: trunk
01:22
Fix a bug in matrix generation. Relax a restriction on the use of VALUES clauses - a restriction that did not actually apply. Fix a formatting problem in the FTS5 docs. check-in: f61b2a7935 user: drh tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to pages/pragma.in.

1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
....
1223
1224
1225
1226
1227
1228
1229
1230
1231









1232
1233
1234
1235
1236
1237
1238

Pragma index_info {
    <p>^(<b>PRAGMA DB.index_info(</b><i>index-name</i><b>);</b></p>
    <p>This pragma returns one row for each key column in the named index.)^
    A key column is a column that is actually named in the [CREATE INDEX]
    index statement or [UNIQUE constraint] or [PRIMARY KEY constraint] that
    created the index.  Index entries also usually contain auxiliary
    columns that point back to the table row being indexed.  The auxiliary
    index-columns are not shown by the index_info pragma, but they are
    listed by the [index_xinfo pragma].</p>

    <p>Output columns from the index_info pragma are as follows:
    <ol>
    <li>^(The rank of the column within the index.  (0 means left-most.))^
    <li>^The rank of the column within the table being indexed.
    <li>^The name of the column being indexed.
    <li>^1 if the index-column is indexed in DESC order and 0 if
         the index-column is in ASC order.
    <li>^The name of the [collating sequence]
         used to compare values in the index-column.
    <li>^1 if the index column is a key column.  ^((This is always 1 for the
         index_info pragma by may be 0 for the [index_xinfo pragma].))^
    </ol>
}

Pragma index_xinfo {
    <p>^(<b>PRAGMA DB.index_xinfo(</b><i>index-name</i><b>);</b></p>
    <p>This pragma returns information about every column in an index.)^
    ^(Unlike this [index_info pragma], this pragma returns information about
................................................................................
    </ol>
}

Pragma index_list {
    <p>^(<b>PRAGMA DB.index_list(</b><i>table-name</i><b>);</b></p>
    <p>This pragma returns one row for each index associated with the
    given table.)^
    ^Columns of the result set include the
    index name and a flag to indicate whether or not the index is UNIQUE.









    </p>
}

TestPragma stats {
    <p>^(<b>PRAGMA stats;</b>)^ </p>
    <p>This pragma returns auxiliary information about tables and
    indices.  The returned information is used during testing to help







|








<
<
<
<
<
<







 







|
|
>
>
>
>
>
>
>
>
>







1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189






1190
1191
1192
1193
1194
1195
1196
....
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241

Pragma index_info {
    <p>^(<b>PRAGMA DB.index_info(</b><i>index-name</i><b>);</b></p>
    <p>This pragma returns one row for each key column in the named index.)^
    A key column is a column that is actually named in the [CREATE INDEX]
    index statement or [UNIQUE constraint] or [PRIMARY KEY constraint] that
    created the index.  Index entries also usually contain auxiliary
    columns that point back to the table row being indexed.  ^The auxiliary
    index-columns are not shown by the index_info pragma, but they are
    listed by the [index_xinfo pragma].</p>

    <p>Output columns from the index_info pragma are as follows:
    <ol>
    <li>^(The rank of the column within the index.  (0 means left-most.))^
    <li>^The rank of the column within the table being indexed.
    <li>^The name of the column being indexed.






    </ol>
}

Pragma index_xinfo {
    <p>^(<b>PRAGMA DB.index_xinfo(</b><i>index-name</i><b>);</b></p>
    <p>This pragma returns information about every column in an index.)^
    ^(Unlike this [index_info pragma], this pragma returns information about
................................................................................
    </ol>
}

Pragma index_list {
    <p>^(<b>PRAGMA DB.index_list(</b><i>table-name</i><b>);</b></p>
    <p>This pragma returns one row for each index associated with the
    given table.)^
    <p>Output columns from the index_list pragma are as follows:
    <ol>
    <li>^(A sequence number assigned to each index for internal tracking
          purposes.)^
    <li>^(The name of the index.)^
    <li>^("1" if the index is UNIQUE and "0" if not.)^
    <li>^("c" if the index was created by a [CREATE INDEX] statement,
          "u" if the index was created by a [UNIQUE constraint], or
          "pk" if the index was created by a [PRIMARY KEY constraint].)^
    <li>^("1" if the index is a [partial index] and "0" if not.)^
    </ol>
    </p>
}

TestPragma stats {
    <p>^(<b>PRAGMA stats;</b>)^ </p>
    <p>This pragma returns auxiliary information about tables and
    indices.  The returned information is used during testing to help