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

Overview

Artifact ID:	2b6c12376ad40bd1288c9e578ce0e2cf9ed6234a
Page Name:	DbFunctions
Date:	2014-03-18 16:03:40
Original User:	stephan
Parent:	5ca018256b3b8772b762b6dad56e3689edbe2f7f (diff)
Next	82bf79249957191ed55e44b3c28d88758dbb9aa3

Content

Fossil Database Schemas

The Fossil DB schemas can be perused, in the form of commented SQL, in the API docs.

The library reserved the db symbol prefixes "fsl_" and "fx_fsl_" (case-insensitive) for its own use - clients should not define any functions or tables with those name prefixes. Fossil(1) reserves all table names which do not start with "fx_" ("fossil extension"). During a rebuild, fossil(1) will drop any repo tables it does not know about unless their names start with "fx_".

Fossil DB User-defined Functions

A fossil-bound DB handle gets a few extra SQL-callable functions, as listed below in alphabetical order...

FSL_CI_MTIME()

FSL_CI_MTIME(INT,INT) takes two RIDs as arguments: the manifest (checkin) version RID and the blob.rid value of a file which part of the first RID's checkin.

It behaves like fsl_mtime_of_manifest_file(), returning the calculated (and highly synthetic!) mtime as an SQL integer (Unix epoch timestamp). This is primarily for internal use.

FSL_CONTENT()

FSL_CONTENT(INTEGER|STRING) returns the undeltified, uncompressed content for the blob record with the given RID (if the argument is an integer) or symbolic name (as per fsl_sym_to_rid()). If the argument does not resolve to an in-repo blob, a db-level error is triggered. If passed an integer, no validation is done on its validity, but such checking can be enforced by instead passing the the RID as a string in the form "rid:THE_RID".

FSL_DIRPART()

FSL_DIRPART(STRING[, BOOL=0]) behaves like fsl_file_dirpart(), returning the result as a string unless it is empty, in which case the result is an SQL NULL.

An example of getting all directory names in the repository (across all file versions, for simplicity):

SELECT DISTINCT(fsl_dirpart(name)) n
FROM filename WHERE n IS NOT NULL
ORDER BY n

To get all the dirs for a specific version one needs to do more work. We'll leave that as an exercise for... me, and once i figure it out i'll post it. It seems that getting that information requires C-level code for the time being.

FSL_IS_ENQUEUED() and FSL_IF_ENQUEUED()

FSL_IS_ENQUEUED(INT) determines whether a given file is "enqueued" in a pending checkin operation. This is normally only used internally, but "might" have some uses elsewhere. If no files have explicitly been queued up for checkin (via the fsl_checkin_file_enqueue() C function) then all files are considered to be selected (though only modified files would actually be checked in if a commit were made).

As its argument it expects a vfile.id field value (vfile is the table where fossil tracks the current checkout's status). It returns a truthy value if that file is selected/enqueued, else a falsy value.

FSL_IF_ENQUEUED(INT,X,Y) is a close counterpart of FSL_IS_ENQUEUED(). If the vfile.id passes as the first parameter is enqueued then it resolves to the X value, else to the Y value, unless Y is NULL, in which case it always resolves to X. Why? Because its only intended usage is to be passed the (id, pathname, origname) fields from the vfile table.

FSL_IF_ENQUEUED(I,X,Y) is basically equivalent to this pseudocode:

result = FSL_IS_ENQUEUED(I) ? X : ((Y IS NULL) ? X : Y)

FSL_J2U()

FSL_J2U(JULIAN_DAY) expects a Julian Day value and returns its equivalent in Unix Epoch timestamp as a 64-bit integer, as per fsl_julian_to_unix(). Fossil tends to use Julian Days for recording timestamps, but a small few cases use Unix timestamps.

FSL_SYM2RID()

FSL_SYM2RID(STRING) returns a blob RID for the given symbol, as per fsl_sym_to_rid(). Triggers an SQL error if fsl_sym_to_rid() fails.

FSL_USER()

Returns the current value of fsl_cx_user_get(), or NULL if that is not set.

NOW()

Returns the current time as an integer, as per time(2).