libfossil  Hex Artifact Content

Artifact 2609b771c7af59f81a8445a0e4942e22c8b6aab3:

Wiki page [DbFunctions] by stephan 2016-01-13 17:53:01.
0000: 44 20 32 30 31 36 2d 30 31 2d 31 33 54 31 37 3a  D 2016-01-13T17:
0010: 35 33 3a 30 31 2e 30 33 30 0a 4c 20 44 62 46 75  53:01.030.L DbFu
0020: 6e 63 74 69 6f 6e 73 0a 50 20 62 62 33 35 38 31  nctions.P bb3581
0030: 33 33 35 37 62 31 36 66 35 35 64 63 30 30 62 37  3357b16f55dc00b7
0040: 30 30 30 32 31 38 61 36 32 35 38 65 35 62 62 39  000218a6258e5bb9
0050: 65 35 0a 55 20 73 74 65 70 68 61 6e 0a 57 20 35  e5.U stephan.W 5
0060: 31 37 36 0a 3c 68 31 3e 46 6f 73 73 69 6c 20 44  176.<h1>Fossil D
0070: 61 74 61 62 61 73 65 20 53 63 68 65 6d 61 73 3c  atabase Schemas<
0080: 2f 68 31 3e 0d 0a 0d 0a 54 68 65 20 46 6f 73 73  /h1>....The Foss
0090: 69 6c 20 44 42 20 73 63 68 65 6d 61 73 20 63 61  il DB schemas ca
00a0: 6e 20 62 65 20 70 65 72 75 73 65 64 2c 20 69 6e  n be perused, in
00b0: 20 74 68 65 20 66 6f 72 6d 20 6f 66 0d 0a 63 6f   the form of..co
00c0: 6d 6d 65 6e 74 65 64 20 53 51 4c 2c 20 69 6e 20  mmented SQL, in 
00d0: 5b 68 74 74 70 3a 2f 2f 66 6f 73 73 69 6c 2e 77  [http://fossil.w
00e0: 61 6e 64 65 72 69 6e 67 68 6f 72 73 65 2e 6e 65  anderinghorse.ne
00f0: 74 2f 72 65 70 6f 73 2f 6c 69 62 66 6f 73 73 69  t/repos/libfossi
0100: 6c 2f 64 6f 78 79 67 65 6e 2f 7c 74 68 65 20 41  l/doxygen/|the A
0110: 50 49 20 64 6f 63 73 5d 2e 0d 0a 0d 0a 54 68 65  PI docs].....The
0120: 20 6c 69 62 72 61 72 79 20 72 65 73 65 72 76 65   library reserve
0130: 73 20 74 68 65 20 64 62 20 73 79 6d 62 6f 6c 20  s the db symbol 
0140: 70 72 65 66 69 78 65 73 20 22 66 73 6c 5f 22 20  prefixes "fsl_" 
0150: 61 6e 64 20 22 66 78 5f 66 73 6c 5f 22 20 28 63  and "fx_fsl_" (c
0160: 61 73 65 2d 69 6e 73 65 6e 73 69 74 69 76 65 29  ase-insensitive)
0170: 20 66 6f 72 20 69 74 73 20 6f 77 6e 20 75 73 65   for its own use
0180: 20 2d 20 63 6c 69 65 6e 74 73 20 73 68 6f 75 6c   - clients shoul
0190: 64 20 6e 6f 74 20 64 65 66 69 6e 65 20 61 6e 79  d not define any
01a0: 20 66 75 6e 63 74 69 6f 6e 73 20 6f 72 20 74 61   functions or ta
01b0: 62 6c 65 73 20 77 69 74 68 20 74 68 6f 73 65 20  bles with those 
01c0: 6e 61 6d 65 20 70 72 65 66 69 78 65 73 2e 20 46  name prefixes. F
01d0: 6f 73 73 69 6c 28 31 29 20 72 65 73 65 72 76 65  ossil(1) reserve
01e0: 73 20 3c 65 6d 3e 61 6c 6c 3c 2f 65 6d 3e 20 74  s <em>all</em> t
01f0: 61 62 6c 65 20 6e 61 6d 65 73 20 77 68 69 63 68  able names which
0200: 20 64 6f 20 6e 6f 74 20 73 74 61 72 74 20 77 69   do not start wi
0210: 74 68 20 22 66 78 5f 22 20 28 22 66 6f 73 73 69  th "fx_" ("fossi
0220: 6c 20 65 78 74 65 6e 73 69 6f 6e 22 29 2e 20 44  l extension"). D
0230: 75 72 69 6e 67 20 61 20 72 65 62 75 69 6c 64 2c  uring a rebuild,
0240: 20 66 6f 73 73 69 6c 28 31 29 20 77 69 6c 6c 20   fossil(1) will 
0250: 3c 65 6d 3e 64 72 6f 70 3c 2f 65 6d 3e 20 61 6e  <em>drop</em> an
0260: 79 20 72 65 70 6f 20 74 61 62 6c 65 73 20 69 74  y repo tables it
0270: 20 64 6f 65 73 20 6e 6f 74 20 6b 6e 6f 77 20 61   does not know a
0280: 62 6f 75 74 20 75 6e 6c 65 73 73 20 74 68 65 69  bout unless thei
0290: 72 20 6e 61 6d 65 73 20 73 74 61 72 74 20 77 69  r names start wi
02a0: 74 68 20 22 66 78 5f 22 2e 0d 0a 0d 0a 0d 0a 3c  th "fx_".......<
02b0: 68 31 3e 46 6f 73 73 69 6c 20 44 42 20 55 73 65  h1>Fossil DB Use
02c0: 72 2d 64 65 66 69 6e 65 64 20 46 75 6e 63 74 69  r-defined Functi
02d0: 6f 6e 73 3c 2f 68 31 3e 0d 0a 0d 0a 41 20 66 6f  ons</h1>....A fo
02e0: 73 73 69 6c 2d 62 6f 75 6e 64 20 44 42 20 68 61  ssil-bound DB ha
02f0: 6e 64 6c 65 20 67 65 74 73 20 61 20 66 65 77 20  ndle gets a few 
0300: 65 78 74 72 61 20 53 51 4c 2d 63 61 6c 6c 61 62  extra SQL-callab
0310: 6c 65 20 66 75 6e 63 74 69 6f 6e 73 2c 20 61 73  le functions, as
0320: 0d 0a 6c 69 73 74 65 64 20 62 65 6c 6f 77 20 69  ..listed below i
0330: 6e 20 61 6c 70 68 61 62 65 74 69 63 61 6c 20 6f  n alphabetical o
0340: 72 64 65 72 2e 2e 2e 0d 0a 0d 0a 3c 68 33 3e 46  rder.......<h3>F
0350: 53 4c 5f 43 4b 4f 55 54 5f 44 49 52 28 29 3c 2f  SL_CKOUT_DIR()</
0360: 68 33 3e 0d 0a 0d 0a 3c 74 74 3e 46 53 4c 5f 43  h3>....<tt>FSL_C
0370: 4b 4f 55 54 5f 44 49 52 28 3c 6e 6f 77 69 6b 69  KOUT_DIR(<nowiki
0380: 3e 5b 49 4e 54 45 47 45 52 3d 31 5d 3c 2f 6e 6f  >[INTEGER=1]</no
0390: 77 69 6b 69 3e 29 3c 2f 74 74 3e 20 72 65 74 75  wiki>)</tt> retu
03a0: 72 6e 73 20 74 68 65 20 70 61 74 68 20 74 6f 20  rns the path to 
03b0: 74 68 65 20 63 75 72 72 65 6e 74 20 63 68 65 63  the current chec
03c0: 6b 6f 75 74 20 64 69 72 65 63 74 6f 72 79 2c 20  kout directory, 
03d0: 6f 72 20 4e 55 4c 4c 20 69 66 20 6e 6f 20 63 68  or NULL if no ch
03e0: 65 63 6b 6f 75 74 20 69 73 20 6f 70 65 6e 65 64  eckout is opened
03f0: 2e 20 49 66 20 70 61 73 73 65 64 20 6e 6f 20 61  . If passed no a
0400: 72 67 75 6d 65 6e 74 20 6f 72 20 70 61 73 73 65  rgument or passe
0410: 64 20 61 20 76 61 6c 75 65 20 77 68 69 63 68 20  d a value which 
0420: 65 76 61 6c 75 61 74 65 73 20 74 6f 20 6e 6f 6e  evaluates to non
0430: 2d 30 20 69 6e 20 61 6e 20 69 6e 74 65 67 65 72  -0 in an integer
0440: 20 63 6f 6e 74 65 78 74 2c 20 74 68 65 20 74 72   context, the tr
0450: 61 69 6c 69 6e 67 20 73 6c 61 73 68 20 69 73 20  ailing slash is 
0460: 69 6e 63 6c 75 64 65 64 20 69 6e 20 74 68 65 20  included in the 
0470: 72 65 74 75 72 6e 65 64 20 76 61 6c 75 65 20 28  returned value (
0480: 77 68 69 63 68 20 69 73 20 46 6f 73 73 69 6c 27  which is Fossil'
0490: 73 20 68 69 73 74 6f 72 69 63 61 6c 20 63 6f 6e  s historical con
04a0: 76 65 6e 74 69 6f 6e 20 77 69 74 68 20 72 65 67  vention with reg
04b0: 61 72 64 20 74 6f 20 64 69 72 65 63 74 6f 72 79  ard to directory
04c0: 20 6e 61 6d 65 73 29 2e 20 49 66 20 70 61 73 73   names). If pass
04d0: 65 64 20 61 6e 79 20 76 61 6c 75 65 20 77 68 69  ed any value whi
04e0: 63 68 20 65 76 61 6c 75 61 74 65 73 20 74 6f 20  ch evaluates to 
04f0: 69 6e 74 65 67 65 72 20 30 2c 20 74 68 65 20 73  integer 0, the s
0500: 6c 61 73 68 20 69 73 20 6e 6f 74 20 69 6e 63 6c  lash is not incl
0510: 75 64 65 64 2e 0d 0a 0d 0a 65 2e 67 2e 20 74 6f  uded.....e.g. to
0520: 20 67 65 74 20 74 68 65 20 70 61 74 68 20 74 6f   get the path to
0530: 20 74 68 65 20 22 2e 66 6f 73 73 69 6c 2d 73 65   the ".fossil-se
0540: 74 74 69 6e 67 73 22 20 28 76 65 72 73 69 6f 6e  ttings" (version
0550: 61 62 6c 65 20 73 65 74 74 69 6e 67 73 29 20 64  able settings) d
0560: 69 72 65 63 74 6f 72 79 20 66 6f 72 20 74 68 65  irectory for the
0570: 20 63 75 72 72 65 6e 74 20 63 68 65 63 6b 6f 75   current checkou
0580: 74 3a 0d 0a 0d 0a 3c 6e 6f 77 69 6b 69 3e 3c 70  t:....<nowiki><p
0590: 72 65 3e 53 45 4c 45 43 54 20 46 53 4c 5f 43 4b  re>SELECT FSL_CK
05a0: 4f 55 54 5f 44 49 52 28 29 20 7c 7c 20 27 2e 66  OUT_DIR() || '.f
05b0: 6f 73 73 69 6c 2d 73 65 74 74 69 6e 67 73 27 3b  ossil-settings';
05c0: 0d 0a 3c 2f 70 72 65 3e 3c 2f 6e 6f 77 69 6b 69  ..</pre></nowiki
05d0: 3e 0d 0a 0d 0a 0d 0a 3c 68 33 3e 46 53 4c 5f 43  >......<h3>FSL_C
05e0: 49 5f 4d 54 49 4d 45 28 29 3c 2f 68 33 3e 0d 0a  I_MTIME()</h3>..
05f0: 0d 0a 3c 74 74 3e 46 53 4c 5f 43 49 5f 4d 54 49  ..<tt>FSL_CI_MTI
0600: 4d 45 28 49 4e 54 2c 49 4e 54 29 3c 2f 74 74 3e  ME(INT,INT)</tt>
0610: 20 74 61 6b 65 73 20 74 77 6f 20 52 49 44 73 20   takes two RIDs 
0620: 61 73 20 61 72 67 75 6d 65 6e 74 73 3a 20 74 68  as arguments: th
0630: 65 20 6d 61 6e 69 66 65 73 74 20 28 63 68 65 63  e manifest (chec
0640: 6b 69 6e 29 20 76 65 72 73 69 6f 6e 20 52 49 44  kin) version RID
0650: 20 61 6e 64 20 74 68 65 20 62 6c 6f 62 2e 72 69   and the blob.ri
0660: 64 20 76 61 6c 75 65 20 6f 66 20 61 20 66 69 6c  d value of a fil
0670: 65 20 77 68 69 63 68 20 70 61 72 74 20 6f 66 20  e which part of 
0680: 74 68 65 20 66 69 72 73 74 20 52 49 44 27 73 20  the first RID's 
0690: 63 68 65 63 6b 69 6e 2e 0d 0a 0d 0a 49 74 20 62  checkin.....It b
06a0: 65 68 61 76 65 73 20 6c 69 6b 65 20 3c 74 74 3e  ehaves like <tt>
06b0: 66 73 6c 5f 6d 74 69 6d 65 5f 6f 66 5f 6d 61 6e  fsl_mtime_of_man
06c0: 69 66 65 73 74 5f 66 69 6c 65 28 29 3c 2f 74 74  ifest_file()</tt
06d0: 3e 2c 20 72 65 74 75 72 6e 69 6e 67 20 74 68 65  >, returning the
06e0: 20 63 61 6c 63 75 6c 61 74 65 64 20 28 61 6e 64   calculated (and
06f0: 20 68 69 67 68 6c 79 20 73 79 6e 74 68 65 74 69   highly syntheti
0700: 63 21 29 20 6d 74 69 6d 65 20 61 73 20 61 6e 20  c!) mtime as an 
0710: 53 51 4c 20 69 6e 74 65 67 65 72 20 28 55 6e 69  SQL integer (Uni
0720: 78 20 65 70 6f 63 68 20 74 69 6d 65 73 74 61 6d  x epoch timestam
0730: 70 29 2e 20 54 68 69 73 20 69 73 20 70 72 69 6d  p). This is prim
0740: 61 72 69 6c 79 0d 0a 66 6f 72 20 69 6e 74 65 72  arily..for inter
0750: 6e 61 6c 20 75 73 65 2e 0d 0a 0d 0a 0d 0a 3c 68  nal use.......<h
0760: 33 3e 46 53 4c 5f 43 4f 4e 54 45 4e 54 28 29 3c  3>FSL_CONTENT()<
0770: 2f 68 33 3e 0d 0a 0d 0a 3c 74 74 3e 46 53 4c 5f  /h3>....<tt>FSL_
0780: 43 4f 4e 54 45 4e 54 28 49 4e 54 45 47 45 52 7c  CONTENT(INTEGER|
0790: 53 54 52 49 4e 47 29 3c 2f 74 74 3e 20 72 65 74  STRING)</tt> ret
07a0: 75 72 6e 73 20 74 68 65 20 75 6e 64 65 6c 74 69  urns the undelti
07b0: 66 69 65 64 2c 0d 0a 75 6e 63 6f 6d 70 72 65 73  fied,..uncompres
07c0: 73 65 64 20 63 6f 6e 74 65 6e 74 20 66 6f 72 20  sed content for 
07d0: 74 68 65 20 62 6c 6f 62 20 72 65 63 6f 72 64 20  the blob record 
07e0: 77 69 74 68 20 74 68 65 20 67 69 76 65 6e 20 52  with the given R
07f0: 49 44 20 28 69 66 0d 0a 74 68 65 20 61 72 67 75  ID (if..the argu
0800: 6d 65 6e 74 20 69 73 20 61 6e 20 69 6e 74 65 67  ment is an integ
0810: 65 72 29 20 6f 72 20 73 79 6d 62 6f 6c 69 63 20  er) or symbolic 
0820: 6e 61 6d 65 20 28 61 73 20 70 65 72 0d 0a 66 73  name (as per..fs
0830: 6c 5f 73 79 6d 5f 74 6f 5f 72 69 64 28 29 29 2e  l_sym_to_rid()).
0840: 20 49 66 20 74 68 65 20 61 72 67 75 6d 65 6e 74   If the argument
0850: 20 64 6f 65 73 20 6e 6f 74 20 72 65 73 6f 6c 76   does not resolv
0860: 65 20 74 6f 20 61 6e 0d 0a 69 6e 2d 72 65 70 6f  e to an..in-repo
0870: 20 62 6c 6f 62 2c 20 61 20 64 62 2d 6c 65 76 65   blob, a db-leve
0880: 6c 20 65 72 72 6f 72 20 69 73 20 74 72 69 67 67  l error is trigg
0890: 65 72 65 64 2e 20 49 66 20 70 61 73 73 65 64 20  ered. If passed 
08a0: 61 6e 0d 0a 69 6e 74 65 67 65 72 2c 20 6e 6f 20  an..integer, no 
08b0: 76 61 6c 69 64 61 74 69 6f 6e 20 69 73 20 64 6f  validation is do
08c0: 6e 65 20 6f 6e 20 69 74 73 20 76 61 6c 69 64 69  ne on its validi
08d0: 74 79 2c 20 62 75 74 20 73 75 63 68 0d 0a 63 68  ty, but such..ch
08e0: 65 63 6b 69 6e 67 20 63 61 6e 20 62 65 20 65 6e  ecking can be en
08f0: 66 6f 72 63 65 64 20 62 79 20 69 6e 73 74 65 61  forced by instea
0900: 64 20 70 61 73 73 69 6e 67 20 74 68 65 20 74 68  d passing the th
0910: 65 20 52 49 44 20 61 73 0d 0a 61 20 73 74 72 69  e RID as..a stri
0920: 6e 67 20 69 6e 20 74 68 65 20 66 6f 72 6d 20 22  ng in the form "
0930: 72 69 64 3a 54 48 45 5f 52 49 44 22 2e 0d 0a 0d  rid:THE_RID"....
0940: 0a 0d 0a 3c 68 33 3e 46 53 4c 5f 44 49 52 50 41  ...<h3>FSL_DIRPA
0950: 52 54 28 29 3c 2f 68 33 3e 0d 0a 0d 0a 3c 74 74  RT()</h3>....<tt
0960: 3e 3c 6e 6f 77 69 6b 69 3e 46 53 4c 5f 44 49 52  ><nowiki>FSL_DIR
0970: 50 41 52 54 28 53 54 52 49 4e 47 5b 2c 20 42 4f  PART(STRING[, BO
0980: 4f 4c 3d 30 5d 29 3c 2f 6e 6f 77 69 6b 69 3e 3c  OL=0])</nowiki><
0990: 2f 74 74 3e 20 62 65 68 61 76 65 73 20 6c 69 6b  /tt> behaves lik
09a0: 65 0d 0a 66 73 6c 5f 66 69 6c 65 5f 64 69 72 70  e..fsl_file_dirp
09b0: 61 72 74 28 29 2c 20 72 65 74 75 72 6e 69 6e 67  art(), returning
09c0: 20 74 68 65 20 72 65 73 75 6c 74 20 61 73 20 61   the result as a
09d0: 20 73 74 72 69 6e 67 0d 0a 75 6e 6c 65 73 73 20   string..unless 
09e0: 69 74 20 69 73 20 65 6d 70 74 79 2c 20 69 6e 20  it is empty, in 
09f0: 77 68 69 63 68 20 63 61 73 65 20 74 68 65 20 72  which case the r
0a00: 65 73 75 6c 74 20 69 73 20 61 6e 0d 0a 53 51 4c  esult is an..SQL
0a10: 20 4e 55 4c 4c 2e 0d 0a 0d 0a 41 6e 20 65 78 61   NULL.....An exa
0a20: 6d 70 6c 65 20 6f 66 20 67 65 74 74 69 6e 67 20  mple of getting 
0a30: 61 6c 6c 20 64 69 72 65 63 74 6f 72 79 20 6e 61  all directory na
0a40: 6d 65 73 20 69 6e 20 74 68 65 20 72 65 70 6f 73  mes in the repos
0a50: 69 74 6f 72 79 20 28 61 63 72 6f 73 73 20 61 6c  itory (across al
0a60: 6c 0d 0a 66 69 6c 65 20 76 65 72 73 69 6f 6e 73  l..file versions
0a70: 2c 20 66 6f 72 20 73 69 6d 70 6c 69 63 69 74 79  , for simplicity
0a80: 29 3a 0d 0a 0d 0a 3c 6e 6f 77 69 6b 69 3e 3c 70  ):....<nowiki><p
0a90: 72 65 3e 0d 0a 53 45 4c 45 43 54 20 44 49 53 54  re>..SELECT DIST
0aa0: 49 4e 43 54 28 66 73 6c 5f 64 69 72 70 61 72 74  INCT(fsl_dirpart
0ab0: 28 6e 61 6d 65 29 29 20 6e 0d 0a 46 52 4f 4d 20  (name)) n..FROM 
0ac0: 66 69 6c 65 6e 61 6d 65 20 57 48 45 52 45 20 6e  filename WHERE n
0ad0: 20 49 53 20 4e 4f 54 20 4e 55 4c 4c 0d 0a 4f 52   IS NOT NULL..OR
0ae0: 44 45 52 20 42 59 20 6e 0d 0a 3c 2f 70 72 65 3e  DER BY n..</pre>
0af0: 3c 2f 6e 6f 77 69 6b 69 3e 0d 0a 0d 0a 54 6f 20  </nowiki>....To 
0b00: 67 65 74 20 61 6c 6c 20 74 68 65 20 64 69 72 73  get all the dirs
0b10: 20 66 6f 72 20 61 20 73 70 65 63 69 66 69 63 20   for a specific 
0b20: 76 65 72 73 69 6f 6e 20 6f 6e 65 20 6e 65 65 64  version one need
0b30: 73 20 74 6f 20 64 6f 20 6d 6f 72 65 20 77 6f 72  s to do more wor
0b40: 6b 2e 20 57 65 27 6c 6c 20 6c 65 61 76 65 20 74  k. We'll leave t
0b50: 68 61 74 20 61 73 20 61 6e 20 65 78 65 72 63 69  hat as an exerci
0b60: 73 65 20 66 6f 72 2e 2e 2e 20 6d 65 2c 20 61 6e  se for... me, an
0b70: 64 20 6f 6e 63 65 20 69 20 66 69 67 75 72 65 20  d once i figure 
0b80: 69 74 20 6f 75 74 20 69 27 6c 6c 20 70 6f 73 74  it out i'll post
0b90: 20 69 74 2e 20 49 74 20 73 65 65 6d 73 20 74 68   it. It seems th
0ba0: 61 74 20 67 65 74 74 69 6e 67 20 74 68 61 74 20  at getting that 
0bb0: 69 6e 66 6f 72 6d 61 74 69 6f 6e 20 72 65 71 75  information requ
0bc0: 69 72 65 73 20 43 2d 6c 65 76 65 6c 20 63 6f 64  ires C-level cod
0bd0: 65 20 66 6f 72 20 74 68 65 20 74 69 6d 65 20 62  e for the time b
0be0: 65 69 6e 67 2e 0d 0a 0d 0a 3c 68 33 3e 46 53 4c  eing.....<h3>FSL
0bf0: 5f 49 53 5f 45 4e 51 55 45 55 45 44 28 29 20 61  _IS_ENQUEUED() a
0c00: 6e 64 20 46 53 4c 5f 49 46 5f 45 4e 51 55 45 55  nd FSL_IF_ENQUEU
0c10: 45 44 28 29 3c 2f 68 33 3e 0d 0a 0d 0a 3c 74 74  ED()</h3>....<tt
0c20: 3e 46 53 4c 5f 49 53 5f 45 4e 51 55 45 55 45 44  >FSL_IS_ENQUEUED
0c30: 28 49 4e 54 29 3c 2f 74 74 3e 20 64 65 74 65 72  (INT)</tt> deter
0c40: 6d 69 6e 65 73 20 77 68 65 74 68 65 72 20 61 20  mines whether a 
0c50: 67 69 76 65 6e 20 66 69 6c 65 20 69 73 20 22 65  given file is "e
0c60: 6e 71 75 65 75 65 64 22 20 69 6e 20 61 20 70 65  nqueued" in a pe
0c70: 6e 64 69 6e 67 20 63 68 65 63 6b 69 6e 20 6f 70  nding checkin op
0c80: 65 72 61 74 69 6f 6e 2e 20 54 68 69 73 20 69 73  eration. This is
0c90: 20 6e 6f 72 6d 61 6c 6c 79 20 6f 6e 6c 79 20 75   normally only u
0ca0: 73 65 64 20 69 6e 74 65 72 6e 61 6c 6c 79 2c 20  sed internally, 
0cb0: 62 75 74 20 22 6d 69 67 68 74 22 20 68 61 76 65  but "might" have
0cc0: 20 73 6f 6d 65 20 75 73 65 73 20 65 6c 73 65 77   some uses elsew
0cd0: 68 65 72 65 2e 20 49 66 20 6e 6f 20 66 69 6c 65  here. If no file
0ce0: 73 20 68 61 76 65 20 65 78 70 6c 69 63 69 74 6c  s have explicitl
0cf0: 79 20 62 65 65 6e 20 71 75 65 75 65 64 20 75 70  y been queued up
0d00: 20 66 6f 72 20 63 68 65 63 6b 69 6e 20 28 76 69   for checkin (vi
0d10: 61 20 74 68 65 20 3c 74 74 3e 66 73 6c 5f 63 68  a the <tt>fsl_ch
0d20: 65 63 6b 69 6e 5f 66 69 6c 65 5f 65 6e 71 75 65  eckin_file_enque
0d30: 75 65 28 29 3c 2f 74 74 3e 20 43 20 66 75 6e 63  ue()</tt> C func
0d40: 74 69 6f 6e 29 20 74 68 65 6e 20 3c 65 6d 3e 61  tion) then <em>a
0d50: 6c 6c 20 66 69 6c 65 73 3c 2f 65 6d 3e 20 61 72  ll files</em> ar
0d60: 65 20 63 6f 6e 73 69 64 65 72 65 64 20 74 6f 20  e considered to 
0d70: 62 65 20 73 65 6c 65 63 74 65 64 20 28 74 68 6f  be selected (tho
0d80: 75 67 68 20 6f 6e 6c 79 20 3c 65 6d 3e 6d 6f 64  ugh only <em>mod
0d90: 69 66 69 65 64 3c 2f 65 6d 3e 20 66 69 6c 65 73  ified</em> files
0da0: 20 77 6f 75 6c 64 20 61 63 74 75 61 6c 6c 79 20   would actually 
0db0: 62 65 20 63 68 65 63 6b 65 64 20 69 6e 20 69 66  be checked in if
0dc0: 20 61 20 63 6f 6d 6d 69 74 20 77 65 72 65 20 6d   a commit were m
0dd0: 61 64 65 29 2e 0d 0a 0d 0a 41 73 20 69 74 73 20  ade).....As its 
0de0: 61 72 67 75 6d 65 6e 74 20 69 74 20 65 78 70 65  argument it expe
0df0: 63 74 73 20 61 20 3c 74 74 3e 76 66 69 6c 65 2e  cts a <tt>vfile.
0e00: 69 64 3c 2f 74 74 3e 20 66 69 65 6c 64 20 76 61  id</tt> field va
0e10: 6c 75 65 20 28 76 66 69 6c 65 20 69 73 20 74 68  lue (vfile is th
0e20: 65 20 74 61 62 6c 65 20 77 68 65 72 65 20 66 6f  e table where fo
0e30: 73 73 69 6c 20 74 72 61 63 6b 73 20 74 68 65 20  ssil tracks the 
0e40: 63 75 72 72 65 6e 74 20 63 68 65 63 6b 6f 75 74  current checkout
0e50: 27 73 20 73 74 61 74 75 73 29 2e 20 49 74 20 72  's status). It r
0e60: 65 74 75 72 6e 73 20 61 20 74 72 75 74 68 79 20  eturns a truthy 
0e70: 76 61 6c 75 65 20 69 66 20 74 68 61 74 20 66 69  value if that fi
0e80: 6c 65 20 69 73 20 73 65 6c 65 63 74 65 64 2f 65  le is selected/e
0e90: 6e 71 75 65 75 65 64 2c 20 65 6c 73 65 20 61 20  nqueued, else a 
0ea0: 66 61 6c 73 79 20 76 61 6c 75 65 2e 0d 0a 0d 0a  falsy value.....
0eb0: 3c 74 74 3e 46 53 4c 5f 49 46 5f 45 4e 51 55 45  <tt>FSL_IF_ENQUE
0ec0: 55 45 44 28 49 4e 54 2c 58 2c 59 29 3c 2f 74 74  UED(INT,X,Y)</tt
0ed0: 3e 20 69 73 20 61 20 63 6c 6f 73 65 20 63 6f 75  > is a close cou
0ee0: 6e 74 65 72 70 61 72 74 20 6f 66 20 3c 74 74 3e  nterpart of <tt>
0ef0: 46 53 4c 5f 49 53 5f 45 4e 51 55 45 55 45 44 28  FSL_IS_ENQUEUED(
0f00: 29 3c 2f 74 74 3e 2e 20 49 66 20 74 68 65 20 3c  )</tt>. If the <
0f10: 74 74 3e 76 66 69 6c 65 2e 69 64 3c 2f 74 74 3e  tt>vfile.id</tt>
0f20: 20 70 61 73 73 65 73 20 61 73 20 74 68 65 20 66   passes as the f
0f30: 69 72 73 74 20 70 61 72 61 6d 65 74 65 72 20 69  irst parameter i
0f40: 73 20 65 6e 71 75 65 75 65 64 20 74 68 65 6e 20  s enqueued then 
0f50: 69 74 20 72 65 73 6f 6c 76 65 73 20 74 6f 20 74  it resolves to t
0f60: 68 65 20 3c 74 74 3e 58 3c 2f 74 74 3e 20 76 61  he <tt>X</tt> va
0f70: 6c 75 65 2c 20 65 6c 73 65 20 74 6f 20 74 68 65  lue, else to the
0f80: 20 3c 74 74 3e 59 3c 2f 74 74 3e 20 76 61 6c 75   <tt>Y</tt> valu
0f90: 65 2c 20 3c 65 6d 3e 75 6e 6c 65 73 73 3c 2f 65  e, <em>unless</e
0fa0: 6d 3e 20 59 20 69 73 20 4e 55 4c 4c 2c 20 69 6e  m> Y is NULL, in
0fb0: 20 77 68 69 63 68 20 63 61 73 65 20 69 74 20 61   which case it a
0fc0: 6c 77 61 79 73 20 72 65 73 6f 6c 76 65 73 20 74  lways resolves t
0fd0: 6f 20 58 2e 20 57 68 79 3f 20 42 65 63 61 75 73  o X. Why? Becaus
0fe0: 65 20 69 74 73 20 6f 6e 6c 79 20 69 6e 74 65 6e  e its only inten
0ff0: 64 65 64 20 75 73 61 67 65 20 69 73 20 74 6f 20  ded usage is to 
1000: 62 65 20 70 61 73 73 65 64 20 74 68 65 20 28 69  be passed the (i
1010: 64 2c 20 70 61 74 68 6e 61 6d 65 2c 20 6f 72 69  d, pathname, ori
1020: 67 6e 61 6d 65 29 20 66 69 65 6c 64 73 20 66 72  gname) fields fr
1030: 6f 6d 20 74 68 65 20 76 66 69 6c 65 20 74 61 62  om the vfile tab
1040: 6c 65 2e 0d 0a 0d 0a 0d 0a 3c 74 74 3e 46 53 4c  le.......<tt>FSL
1050: 5f 49 46 5f 45 4e 51 55 45 55 45 44 28 49 2c 58  _IF_ENQUEUED(I,X
1060: 2c 59 29 3c 2f 74 74 3e 20 69 73 20 62 61 73 69  ,Y)</tt> is basi
1070: 63 61 6c 6c 79 20 65 71 75 69 76 61 6c 65 6e 74  cally equivalent
1080: 20 74 6f 20 74 68 69 73 20 70 73 65 75 64 6f 63   to this pseudoc
1090: 6f 64 65 3a 0d 0a 0d 0a 3c 6e 6f 77 69 6b 69 3e  ode:....<nowiki>
10a0: 3c 70 72 65 3e 0d 0a 72 65 73 75 6c 74 20 3d 20  <pre>..result = 
10b0: 46 53 4c 5f 49 53 5f 45 4e 51 55 45 55 45 44 28  FSL_IS_ENQUEUED(
10c0: 49 29 20 3f 20 58 20 3a 20 28 28 59 20 49 53 20  I) ? X : ((Y IS 
10d0: 4e 55 4c 4c 29 20 3f 20 58 20 3a 20 59 29 0d 0a  NULL) ? X : Y)..
10e0: 3c 2f 70 72 65 3e 3c 2f 6e 6f 77 69 6b 69 3e 0d  </pre></nowiki>.
10f0: 0a 0d 0a 3c 68 33 3e 46 53 4c 5f 4a 32 55 28 29  ...<h3>FSL_J2U()
1100: 3c 2f 68 33 3e 0d 0a 0d 0a 3c 74 74 3e 46 53 4c  </h3>....<tt>FSL
1110: 5f 4a 32 55 28 4a 55 4c 49 41 4e 5f 44 41 59 29  _J2U(JULIAN_DAY)
1120: 3c 2f 74 74 3e 20 65 78 70 65 63 74 73 20 61 20  </tt> expects a 
1130: 4a 75 6c 69 61 6e 20 44 61 79 20 76 61 6c 75 65  Julian Day value
1140: 20 61 6e 64 20 72 65 74 75 72 6e 73 20 69 74 73   and returns its
1150: 20 65 71 75 69 76 61 6c 65 6e 74 20 69 6e 20 55   equivalent in U
1160: 6e 69 78 20 45 70 6f 63 68 20 74 69 6d 65 73 74  nix Epoch timest
1170: 61 6d 70 20 61 73 20 61 20 36 34 2d 62 69 74 20  amp as a 64-bit 
1180: 69 6e 74 65 67 65 72 2c 20 61 73 20 70 65 72 20  integer, as per 
1190: 3c 74 74 3e 66 73 6c 5f 6a 75 6c 69 61 6e 5f 74  <tt>fsl_julian_t
11a0: 6f 5f 75 6e 69 78 28 29 3c 2f 74 74 3e 2e 20 46  o_unix()</tt>. F
11b0: 6f 73 73 69 6c 20 74 65 6e 64 73 20 74 6f 20 75  ossil tends to u
11c0: 73 65 20 4a 75 6c 69 61 6e 20 44 61 79 73 20 66  se Julian Days f
11d0: 6f 72 20 72 65 63 6f 72 64 69 6e 67 20 74 69 6d  or recording tim
11e0: 65 73 74 61 6d 70 73 2c 20 62 75 74 20 61 20 73  estamps, but a s
11f0: 6d 61 6c 6c 20 66 65 77 20 63 61 73 65 73 20 75  mall few cases u
1200: 73 65 20 55 6e 69 78 20 74 69 6d 65 73 74 61 6d  se Unix timestam
1210: 70 73 2e 0d 0a 0d 0a 0d 0a 3c 68 33 3e 46 53 4c  ps.......<h3>FSL
1220: 5f 53 59 4d 32 52 49 44 28 29 3c 2f 68 33 3e 0d  _SYM2RID()</h3>.
1230: 0a 0d 0a 3c 74 74 3e 46 53 4c 5f 53 59 4d 32 52  ...<tt>FSL_SYM2R
1240: 49 44 28 53 54 52 49 4e 47 29 3c 2f 74 74 3e 20  ID(STRING)</tt> 
1250: 72 65 74 75 72 6e 73 20 61 20 62 6c 6f 62 20 52  returns a blob R
1260: 49 44 20 66 6f 72 20 74 68 65 0d 0a 67 69 76 65  ID for the..give
1270: 6e 20 73 79 6d 62 6f 6c 2c 20 61 73 20 70 65 72  n symbol, as per
1280: 20 66 73 6c 5f 73 79 6d 5f 74 6f 5f 72 69 64 28   fsl_sym_to_rid(
1290: 29 2e 20 54 72 69 67 67 65 72 73 20 61 6e 0d 0a  ). Triggers an..
12a0: 53 51 4c 20 65 72 72 6f 72 20 69 66 20 66 73 6c  SQL error if fsl
12b0: 5f 73 79 6d 5f 74 6f 5f 72 69 64 28 29 20 66 61  _sym_to_rid() fa
12c0: 69 6c 73 2e 0d 0a 0d 0a 54 4f 44 4f 3a 20 61 64  ils.....TODO: ad
12d0: 64 20 61 6e 20 6f 70 74 69 6f 6e 61 6c 20 62 6f  d an optional bo
12e0: 6f 6c 65 61 6e 20 73 65 63 6f 6e 64 20 70 61 72  olean second par
12f0: 61 6d 20 28 64 65 66 61 75 6c 74 3d 74 72 75 65  am (default=true
1300: 29 20 77 68 69 63 68 20 74 65 6c 6c 73 20 69 74  ) which tells it
1310: 20 74 6f 20 72 65 74 75 72 6e 20 4e 55 4c 4c 20   to return NULL 
1320: 69 6e 73 74 65 61 64 20 6f 66 20 74 72 69 67 67  instead of trigg
1330: 65 72 69 6e 67 20 61 6e 20 65 72 72 6f 72 2e 0d  ering an error..
1340: 0a 0d 0a 3c 68 33 3e 46 53 4c 5f 55 53 45 52 28  ...<h3>FSL_USER(
1350: 29 3c 2f 68 33 3e 0d 0a 0d 0a 52 65 74 75 72 6e  )</h3>....Return
1360: 73 20 74 68 65 20 63 75 72 72 65 6e 74 20 76 61  s the current va
1370: 6c 75 65 20 6f 66 20 66 73 6c 5f 63 78 5f 75 73  lue of fsl_cx_us
1380: 65 72 5f 67 65 74 28 29 2c 20 6f 72 20 4e 55 4c  er_get(), or NUL
1390: 4c 0d 0a 69 66 20 74 68 61 74 20 69 73 20 6e 6f  L..if that is no
13a0: 74 20 73 65 74 2e 0d 0a 0d 0a 45 78 61 6d 70 6c  t set.....Exampl
13b0: 65 3a 0d 0a 3c 6e 6f 77 69 6b 69 3e 3c 70 72 65  e:..<nowiki><pre
13c0: 3e 0d 0a 23 20 66 2d 71 75 65 72 79 20 2d 65 20  >..# f-query -e 
13d0: 27 73 65 6c 65 63 74 20 66 73 6c 5f 75 73 65 72  'select fsl_user
13e0: 28 29 27 0d 0a 66 73 6c 5f 75 73 65 72 28 29 0d  ()'..fsl_user().
13f0: 0a 73 74 65 70 68 61 6e 0d 0a 0d 0a 23 20 66 2d  .stephan....# f-
1400: 71 75 65 72 79 20 2d 65 20 27 73 65 6c 65 63 74  query -e 'select
1410: 20 66 73 6c 5f 75 73 65 72 28 29 27 20 2d 2d 75   fsl_user()' --u
1420: 73 65 72 20 72 6f 6f 74 0d 0a 66 73 6c 5f 75 73  ser root..fsl_us
1430: 65 72 28 29 0d 0a 72 6f 6f 74 0d 0a 3c 2f 70 72  er()..root..</pr
1440: 65 3e 3c 2f 6e 6f 77 69 6b 69 3e 0d 0a 0d 0a 0d  e></nowiki>.....
1450: 0a 0d 0a 3c 68 33 3e 4e 4f 57 28 29 3c 2f 68 33  ...<h3>NOW()</h3
1460: 3e 0d 0a 0d 0a 52 65 74 75 72 6e 73 20 74 68 65  >....Returns the
1470: 20 63 75 72 72 65 6e 74 20 74 69 6d 65 20 61 73   current time as
1480: 20 61 6e 20 69 6e 74 65 67 65 72 2c 20 61 73 20   an integer, as 
1490: 70 65 72 20 74 69 6d 65 28 32 29 2e 0a 5a 20 36  per time(2)..Z 6
14a0: 34 39 37 39 38 66 39 64 37 30 31 64 64 32 30 61  49798f9d701dd20a
14b0: 33 32 64 32 30 65 33 34 39 63 30 65 33 35 32 0a  32d20e349c0e352.