Fossil SCM
Make the symbolic_name_to_rid() and checkin_mtime() SQL functions available in the "fossil sql" command. Improve the documentation for the files_in_checkin virtual table.
Commit
ba1429cef87c9cb1e27c9281651c7fbbc5f70839
Parent
55243b0d87ca783…
3 files changed
+26
-13
+20
+30
-1
M
src/db.c
+26
-13
| --- src/db.c | ||
| +++ src/db.c | ||
| @@ -757,10 +757,18 @@ | ||
| 757 | 757 | if( rc==0 ){ |
| 758 | 758 | sqlite3_result_int64(context, mtime); |
| 759 | 759 | } |
| 760 | 760 | } |
| 761 | 761 | |
| 762 | +/* | |
| 763 | +** SQL wrapper around the symbolic_name_to_rid() C-language API. | |
| 764 | +** Examples: | |
| 765 | +** | |
| 766 | +** symbolic_name_to_rid('trunk'); | |
| 767 | +** symbolic_name_to_rid('trunk','w'); | |
| 768 | +** | |
| 769 | +*/ | |
| 762 | 770 | void db_sym2rid_function( |
| 763 | 771 | sqlite3_context *context, |
| 764 | 772 | int argc, |
| 765 | 773 | sqlite3_value **argv |
| 766 | 774 | ){ |
| @@ -786,10 +794,23 @@ | ||
| 786 | 794 | sqlite3_result_int64(context, rid); |
| 787 | 795 | } |
| 788 | 796 | } |
| 789 | 797 | } |
| 790 | 798 | |
| 799 | +/* | |
| 800 | +** Register the SQL functions that are useful both to the internal | |
| 801 | +** representation and to the "fossil sql" command. | |
| 802 | +*/ | |
| 803 | +void db_add_aux_functions(sqlite3 *db){ | |
| 804 | + sqlite3_create_function(db, "checkin_mtime", 2, SQLITE_UTF8, 0, | |
| 805 | + db_checkin_mtime_function, 0, 0); | |
| 806 | + sqlite3_create_function(db, "symbolic_name_to_rid", 1, SQLITE_UTF8, 0, | |
| 807 | + db_sym2rid_function, 0, 0); | |
| 808 | + sqlite3_create_function(db, "symbolic_name_to_rid", 2, SQLITE_UTF8, 0, | |
| 809 | + db_sym2rid_function, 0, 0); | |
| 810 | +} | |
| 811 | + | |
| 791 | 812 | |
| 792 | 813 | /* |
| 793 | 814 | ** Open a database file. Return a pointer to the new database |
| 794 | 815 | ** connection. An error results in process abort. |
| 795 | 816 | */ |
| @@ -806,13 +827,12 @@ | ||
| 806 | 827 | if( rc!=SQLITE_OK ){ |
| 807 | 828 | db_err("[%s]: %s", zDbName, sqlite3_errmsg(db)); |
| 808 | 829 | } |
| 809 | 830 | sqlite3_busy_timeout(db, 5000); |
| 810 | 831 | sqlite3_wal_autocheckpoint(db, 1); /* Set to checkpoint frequently */ |
| 811 | - sqlite3_create_function(db, "now", 0, SQLITE_UTF8, 0, db_now_function, 0, 0); | |
| 812 | - sqlite3_create_function(db, "checkin_mtime", 2, SQLITE_UTF8, 0, | |
| 813 | - db_checkin_mtime_function, 0, 0); | |
| 832 | + sqlite3_create_function(db, "now", 0, SQLITE_UTF8, 0, | |
| 833 | + db_now_function, 0, 0); | |
| 814 | 834 | sqlite3_create_function(db, "user", 0, SQLITE_UTF8, 0, db_sql_user, 0, 0); |
| 815 | 835 | sqlite3_create_function(db, "cgi", 1, SQLITE_UTF8, 0, db_sql_cgi, 0, 0); |
| 816 | 836 | sqlite3_create_function(db, "cgi", 2, SQLITE_UTF8, 0, db_sql_cgi, 0, 0); |
| 817 | 837 | sqlite3_create_function(db, "print", -1, SQLITE_UTF8, 0,db_sql_print,0,0); |
| 818 | 838 | sqlite3_create_function( |
| @@ -819,21 +839,14 @@ | ||
| 819 | 839 | db, "is_selected", 1, SQLITE_UTF8, 0, file_is_selected,0,0 |
| 820 | 840 | ); |
| 821 | 841 | sqlite3_create_function( |
| 822 | 842 | db, "if_selected", 3, SQLITE_UTF8, 0, file_is_selected,0,0 |
| 823 | 843 | ); |
| 824 | - sqlite3_create_function( | |
| 825 | - db, "symbolic_name_to_rid", 1, SQLITE_UTF8, 0, db_sym2rid_function, | |
| 826 | - 0, 0 | |
| 827 | - ); | |
| 828 | - sqlite3_create_function( | |
| 829 | - db, "symbolic_name_to_rid", 2, SQLITE_UTF8, 0, db_sym2rid_function, | |
| 830 | - 0, 0 | |
| 831 | - ); | |
| 832 | 844 | if( g.fSqlTrace ) sqlite3_trace(db, db_sql_trace, 0); |
| 833 | - re_add_sql_func(db); | |
| 834 | - foci_register(db); | |
| 845 | + db_add_aux_functions(db); | |
| 846 | + re_add_sql_func(db); /* The REGEXP operator */ | |
| 847 | + foci_register(db); /* The "files_of_checkin" virtual table */ | |
| 835 | 848 | sqlite3_exec(db, "PRAGMA foreign_keys=OFF;", 0, 0, 0); |
| 836 | 849 | return db; |
| 837 | 850 | } |
| 838 | 851 | |
| 839 | 852 | |
| 840 | 853 |
| --- src/db.c | |
| +++ src/db.c | |
| @@ -757,10 +757,18 @@ | |
| 757 | if( rc==0 ){ |
| 758 | sqlite3_result_int64(context, mtime); |
| 759 | } |
| 760 | } |
| 761 | |
| 762 | void db_sym2rid_function( |
| 763 | sqlite3_context *context, |
| 764 | int argc, |
| 765 | sqlite3_value **argv |
| 766 | ){ |
| @@ -786,10 +794,23 @@ | |
| 786 | sqlite3_result_int64(context, rid); |
| 787 | } |
| 788 | } |
| 789 | } |
| 790 | |
| 791 | |
| 792 | /* |
| 793 | ** Open a database file. Return a pointer to the new database |
| 794 | ** connection. An error results in process abort. |
| 795 | */ |
| @@ -806,13 +827,12 @@ | |
| 806 | if( rc!=SQLITE_OK ){ |
| 807 | db_err("[%s]: %s", zDbName, sqlite3_errmsg(db)); |
| 808 | } |
| 809 | sqlite3_busy_timeout(db, 5000); |
| 810 | sqlite3_wal_autocheckpoint(db, 1); /* Set to checkpoint frequently */ |
| 811 | sqlite3_create_function(db, "now", 0, SQLITE_UTF8, 0, db_now_function, 0, 0); |
| 812 | sqlite3_create_function(db, "checkin_mtime", 2, SQLITE_UTF8, 0, |
| 813 | db_checkin_mtime_function, 0, 0); |
| 814 | sqlite3_create_function(db, "user", 0, SQLITE_UTF8, 0, db_sql_user, 0, 0); |
| 815 | sqlite3_create_function(db, "cgi", 1, SQLITE_UTF8, 0, db_sql_cgi, 0, 0); |
| 816 | sqlite3_create_function(db, "cgi", 2, SQLITE_UTF8, 0, db_sql_cgi, 0, 0); |
| 817 | sqlite3_create_function(db, "print", -1, SQLITE_UTF8, 0,db_sql_print,0,0); |
| 818 | sqlite3_create_function( |
| @@ -819,21 +839,14 @@ | |
| 819 | db, "is_selected", 1, SQLITE_UTF8, 0, file_is_selected,0,0 |
| 820 | ); |
| 821 | sqlite3_create_function( |
| 822 | db, "if_selected", 3, SQLITE_UTF8, 0, file_is_selected,0,0 |
| 823 | ); |
| 824 | sqlite3_create_function( |
| 825 | db, "symbolic_name_to_rid", 1, SQLITE_UTF8, 0, db_sym2rid_function, |
| 826 | 0, 0 |
| 827 | ); |
| 828 | sqlite3_create_function( |
| 829 | db, "symbolic_name_to_rid", 2, SQLITE_UTF8, 0, db_sym2rid_function, |
| 830 | 0, 0 |
| 831 | ); |
| 832 | if( g.fSqlTrace ) sqlite3_trace(db, db_sql_trace, 0); |
| 833 | re_add_sql_func(db); |
| 834 | foci_register(db); |
| 835 | sqlite3_exec(db, "PRAGMA foreign_keys=OFF;", 0, 0, 0); |
| 836 | return db; |
| 837 | } |
| 838 | |
| 839 | |
| 840 |
| --- src/db.c | |
| +++ src/db.c | |
| @@ -757,10 +757,18 @@ | |
| 757 | if( rc==0 ){ |
| 758 | sqlite3_result_int64(context, mtime); |
| 759 | } |
| 760 | } |
| 761 | |
| 762 | /* |
| 763 | ** SQL wrapper around the symbolic_name_to_rid() C-language API. |
| 764 | ** Examples: |
| 765 | ** |
| 766 | ** symbolic_name_to_rid('trunk'); |
| 767 | ** symbolic_name_to_rid('trunk','w'); |
| 768 | ** |
| 769 | */ |
| 770 | void db_sym2rid_function( |
| 771 | sqlite3_context *context, |
| 772 | int argc, |
| 773 | sqlite3_value **argv |
| 774 | ){ |
| @@ -786,10 +794,23 @@ | |
| 794 | sqlite3_result_int64(context, rid); |
| 795 | } |
| 796 | } |
| 797 | } |
| 798 | |
| 799 | /* |
| 800 | ** Register the SQL functions that are useful both to the internal |
| 801 | ** representation and to the "fossil sql" command. |
| 802 | */ |
| 803 | void db_add_aux_functions(sqlite3 *db){ |
| 804 | sqlite3_create_function(db, "checkin_mtime", 2, SQLITE_UTF8, 0, |
| 805 | db_checkin_mtime_function, 0, 0); |
| 806 | sqlite3_create_function(db, "symbolic_name_to_rid", 1, SQLITE_UTF8, 0, |
| 807 | db_sym2rid_function, 0, 0); |
| 808 | sqlite3_create_function(db, "symbolic_name_to_rid", 2, SQLITE_UTF8, 0, |
| 809 | db_sym2rid_function, 0, 0); |
| 810 | } |
| 811 | |
| 812 | |
| 813 | /* |
| 814 | ** Open a database file. Return a pointer to the new database |
| 815 | ** connection. An error results in process abort. |
| 816 | */ |
| @@ -806,13 +827,12 @@ | |
| 827 | if( rc!=SQLITE_OK ){ |
| 828 | db_err("[%s]: %s", zDbName, sqlite3_errmsg(db)); |
| 829 | } |
| 830 | sqlite3_busy_timeout(db, 5000); |
| 831 | sqlite3_wal_autocheckpoint(db, 1); /* Set to checkpoint frequently */ |
| 832 | sqlite3_create_function(db, "now", 0, SQLITE_UTF8, 0, |
| 833 | db_now_function, 0, 0); |
| 834 | sqlite3_create_function(db, "user", 0, SQLITE_UTF8, 0, db_sql_user, 0, 0); |
| 835 | sqlite3_create_function(db, "cgi", 1, SQLITE_UTF8, 0, db_sql_cgi, 0, 0); |
| 836 | sqlite3_create_function(db, "cgi", 2, SQLITE_UTF8, 0, db_sql_cgi, 0, 0); |
| 837 | sqlite3_create_function(db, "print", -1, SQLITE_UTF8, 0,db_sql_print,0,0); |
| 838 | sqlite3_create_function( |
| @@ -819,21 +839,14 @@ | |
| 839 | db, "is_selected", 1, SQLITE_UTF8, 0, file_is_selected,0,0 |
| 840 | ); |
| 841 | sqlite3_create_function( |
| 842 | db, "if_selected", 3, SQLITE_UTF8, 0, file_is_selected,0,0 |
| 843 | ); |
| 844 | if( g.fSqlTrace ) sqlite3_trace(db, db_sql_trace, 0); |
| 845 | db_add_aux_functions(db); |
| 846 | re_add_sql_func(db); /* The REGEXP operator */ |
| 847 | foci_register(db); /* The "files_of_checkin" virtual table */ |
| 848 | sqlite3_exec(db, "PRAGMA foreign_keys=OFF;", 0, 0, 0); |
| 849 | return db; |
| 850 | } |
| 851 | |
| 852 | |
| 853 |
+20
| --- src/foci.c | ||
| +++ src/foci.c | ||
| @@ -17,10 +17,30 @@ | ||
| 17 | 17 | ** |
| 18 | 18 | ** This routine implements an SQLite virtual table that gives all of the |
| 19 | 19 | ** files associated with a single checkin. |
| 20 | 20 | ** |
| 21 | 21 | ** The filename "foci" is short for "Files Of CheckIn". |
| 22 | +** | |
| 23 | +** Usage example: | |
| 24 | +** | |
| 25 | +** CREATE VIRTUAL TABLE temp.foci USING files_of_checkin; | |
| 26 | +** -- ^^^^--- important! | |
| 27 | +** SELECT * FROM foci WHERE checkinID=symbolic_name_to_rid('trunk'); | |
| 28 | +** | |
| 29 | +** The symbolic_name_to_rid('trunk') function finds the BLOB.RID value | |
| 30 | +** corresponding to the 'trunk' tag. Then the files_of_checkin virtual table | |
| 31 | +** decodes the manifest defined by that BLOB and returns all files described | |
| 32 | +** by that manifest. The "schema" for the temp.foci table is: | |
| 33 | +** | |
| 34 | +** CREATE TABLE files_of_checkin( | |
| 35 | +** checkinID INTEGER, -- RID for the checkin manifest | |
| 36 | +** filename TEXT, -- Name of a file | |
| 37 | +** uuid TEXT, -- SHA1 hash of the file | |
| 38 | +** previousName TEXT, -- Name of the file in previous checkin | |
| 39 | +** perm TEXT -- Permissions on the file | |
| 40 | +** ); | |
| 41 | +** | |
| 22 | 42 | */ |
| 23 | 43 | #include "config.h" |
| 24 | 44 | #include "foci.h" |
| 25 | 45 | #include <assert.h> |
| 26 | 46 | |
| 27 | 47 |
| --- src/foci.c | |
| +++ src/foci.c | |
| @@ -17,10 +17,30 @@ | |
| 17 | ** |
| 18 | ** This routine implements an SQLite virtual table that gives all of the |
| 19 | ** files associated with a single checkin. |
| 20 | ** |
| 21 | ** The filename "foci" is short for "Files Of CheckIn". |
| 22 | */ |
| 23 | #include "config.h" |
| 24 | #include "foci.h" |
| 25 | #include <assert.h> |
| 26 | |
| 27 |
| --- src/foci.c | |
| +++ src/foci.c | |
| @@ -17,10 +17,30 @@ | |
| 17 | ** |
| 18 | ** This routine implements an SQLite virtual table that gives all of the |
| 19 | ** files associated with a single checkin. |
| 20 | ** |
| 21 | ** The filename "foci" is short for "Files Of CheckIn". |
| 22 | ** |
| 23 | ** Usage example: |
| 24 | ** |
| 25 | ** CREATE VIRTUAL TABLE temp.foci USING files_of_checkin; |
| 26 | ** -- ^^^^--- important! |
| 27 | ** SELECT * FROM foci WHERE checkinID=symbolic_name_to_rid('trunk'); |
| 28 | ** |
| 29 | ** The symbolic_name_to_rid('trunk') function finds the BLOB.RID value |
| 30 | ** corresponding to the 'trunk' tag. Then the files_of_checkin virtual table |
| 31 | ** decodes the manifest defined by that BLOB and returns all files described |
| 32 | ** by that manifest. The "schema" for the temp.foci table is: |
| 33 | ** |
| 34 | ** CREATE TABLE files_of_checkin( |
| 35 | ** checkinID INTEGER, -- RID for the checkin manifest |
| 36 | ** filename TEXT, -- Name of a file |
| 37 | ** uuid TEXT, -- SHA1 hash of the file |
| 38 | ** previousName TEXT, -- Name of the file in previous checkin |
| 39 | ** perm TEXT -- Permissions on the file |
| 40 | ** ); |
| 41 | ** |
| 42 | */ |
| 43 | #include "config.h" |
| 44 | #include "foci.h" |
| 45 | #include <assert.h> |
| 46 | |
| 47 |
+30
-1
| --- src/sqlcmd.c | ||
| +++ src/sqlcmd.c | ||
| @@ -132,10 +132,11 @@ | ||
| 132 | 132 | sqlite3 *db, |
| 133 | 133 | const char **pzErrMsg, |
| 134 | 134 | const void *notUsed |
| 135 | 135 | ){ |
| 136 | 136 | add_content_sql_commands(db); |
| 137 | + db_add_aux_functions(db); | |
| 137 | 138 | re_add_sql_func(db); |
| 138 | 139 | g.zMainDbType = "repository"; |
| 139 | 140 | foci_register(db); |
| 140 | 141 | g.repositoryOpen = 1; |
| 141 | 142 | g.db = db; |
| @@ -147,15 +148,43 @@ | ||
| 147 | 148 | ** |
| 148 | 149 | ** Usage: %fossil sqlite3 ?DATABASE? ?OPTIONS? |
| 149 | 150 | ** |
| 150 | 151 | ** Run the standalone sqlite3 command-line shell on DATABASE with OPTIONS. |
| 151 | 152 | ** If DATABASE is omitted, then the repository that serves the working |
| 152 | -** directory is opened. | |
| 153 | +** directory is opened. See https://www.sqlite.org/cli.html for additional | |
| 154 | +** information. | |
| 153 | 155 | ** |
| 154 | 156 | ** WARNING: Careless use of this command can corrupt a Fossil repository |
| 155 | 157 | ** in ways that are unrecoverable. Be sure you know what you are doing before |
| 156 | 158 | ** running any SQL commands that modifies the repository database. |
| 159 | +** | |
| 160 | +** The following extensions to the usual SQLite commands are provided: | |
| 161 | +** | |
| 162 | +** content(X) Return the contenxt of artifact X. X can be a | |
| 163 | +** SHA1 hash or prefix or a tag. | |
| 164 | +** | |
| 165 | +** compress(X) Compress text X. | |
| 166 | +** | |
| 167 | +** decompress(X) Decompress text X. Undoes the work of | |
| 168 | +** compress(X). | |
| 169 | +** | |
| 170 | +** checkin_mtime(X,Y) Return the mtime for the file Y (a BLOB.RID) | |
| 171 | +** found in check-in X (another BLOB.RID value). | |
| 172 | +** | |
| 173 | +** symbolic_name_to_rid(X) Return a the BLOB.RID corresponding to symbolic | |
| 174 | +** name X. | |
| 175 | +** | |
| 176 | +** REGEXP The REGEXP operator works, unlike in | |
| 177 | +** standard SQLite. | |
| 178 | +** | |
| 179 | +** files_of_checkin The "files_of_check" virtual table is | |
| 180 | +** available for decoding manifests. | |
| 181 | +** | |
| 182 | +** Usage example for files_of_checkin: | |
| 183 | +** | |
| 184 | +** CREATE VIRTUAL TABLE temp.foci USING files_of_checkin; | |
| 185 | +** SELECT * FROM foci WHERE checkinID=symbolic_name_to_rid('trunk'); | |
| 157 | 186 | */ |
| 158 | 187 | void cmd_sqlite3(void){ |
| 159 | 188 | extern int sqlite3_shell(int, char**); |
| 160 | 189 | db_find_and_open_repository(OPEN_ANY_SCHEMA, 0); |
| 161 | 190 | db_close(1); |
| 162 | 191 |
| --- src/sqlcmd.c | |
| +++ src/sqlcmd.c | |
| @@ -132,10 +132,11 @@ | |
| 132 | sqlite3 *db, |
| 133 | const char **pzErrMsg, |
| 134 | const void *notUsed |
| 135 | ){ |
| 136 | add_content_sql_commands(db); |
| 137 | re_add_sql_func(db); |
| 138 | g.zMainDbType = "repository"; |
| 139 | foci_register(db); |
| 140 | g.repositoryOpen = 1; |
| 141 | g.db = db; |
| @@ -147,15 +148,43 @@ | |
| 147 | ** |
| 148 | ** Usage: %fossil sqlite3 ?DATABASE? ?OPTIONS? |
| 149 | ** |
| 150 | ** Run the standalone sqlite3 command-line shell on DATABASE with OPTIONS. |
| 151 | ** If DATABASE is omitted, then the repository that serves the working |
| 152 | ** directory is opened. |
| 153 | ** |
| 154 | ** WARNING: Careless use of this command can corrupt a Fossil repository |
| 155 | ** in ways that are unrecoverable. Be sure you know what you are doing before |
| 156 | ** running any SQL commands that modifies the repository database. |
| 157 | */ |
| 158 | void cmd_sqlite3(void){ |
| 159 | extern int sqlite3_shell(int, char**); |
| 160 | db_find_and_open_repository(OPEN_ANY_SCHEMA, 0); |
| 161 | db_close(1); |
| 162 |
| --- src/sqlcmd.c | |
| +++ src/sqlcmd.c | |
| @@ -132,10 +132,11 @@ | |
| 132 | sqlite3 *db, |
| 133 | const char **pzErrMsg, |
| 134 | const void *notUsed |
| 135 | ){ |
| 136 | add_content_sql_commands(db); |
| 137 | db_add_aux_functions(db); |
| 138 | re_add_sql_func(db); |
| 139 | g.zMainDbType = "repository"; |
| 140 | foci_register(db); |
| 141 | g.repositoryOpen = 1; |
| 142 | g.db = db; |
| @@ -147,15 +148,43 @@ | |
| 148 | ** |
| 149 | ** Usage: %fossil sqlite3 ?DATABASE? ?OPTIONS? |
| 150 | ** |
| 151 | ** Run the standalone sqlite3 command-line shell on DATABASE with OPTIONS. |
| 152 | ** If DATABASE is omitted, then the repository that serves the working |
| 153 | ** directory is opened. See https://www.sqlite.org/cli.html for additional |
| 154 | ** information. |
| 155 | ** |
| 156 | ** WARNING: Careless use of this command can corrupt a Fossil repository |
| 157 | ** in ways that are unrecoverable. Be sure you know what you are doing before |
| 158 | ** running any SQL commands that modifies the repository database. |
| 159 | ** |
| 160 | ** The following extensions to the usual SQLite commands are provided: |
| 161 | ** |
| 162 | ** content(X) Return the contenxt of artifact X. X can be a |
| 163 | ** SHA1 hash or prefix or a tag. |
| 164 | ** |
| 165 | ** compress(X) Compress text X. |
| 166 | ** |
| 167 | ** decompress(X) Decompress text X. Undoes the work of |
| 168 | ** compress(X). |
| 169 | ** |
| 170 | ** checkin_mtime(X,Y) Return the mtime for the file Y (a BLOB.RID) |
| 171 | ** found in check-in X (another BLOB.RID value). |
| 172 | ** |
| 173 | ** symbolic_name_to_rid(X) Return a the BLOB.RID corresponding to symbolic |
| 174 | ** name X. |
| 175 | ** |
| 176 | ** REGEXP The REGEXP operator works, unlike in |
| 177 | ** standard SQLite. |
| 178 | ** |
| 179 | ** files_of_checkin The "files_of_check" virtual table is |
| 180 | ** available for decoding manifests. |
| 181 | ** |
| 182 | ** Usage example for files_of_checkin: |
| 183 | ** |
| 184 | ** CREATE VIRTUAL TABLE temp.foci USING files_of_checkin; |
| 185 | ** SELECT * FROM foci WHERE checkinID=symbolic_name_to_rid('trunk'); |
| 186 | */ |
| 187 | void cmd_sqlite3(void){ |
| 188 | extern int sqlite3_shell(int, char**); |
| 189 | db_find_and_open_repository(OPEN_ANY_SCHEMA, 0); |
| 190 | db_close(1); |
| 191 |