Laserfiche Virtual Tables

The Laserfiche virtual tables are a major component of the Laserfiche Query Language. These virtual tables define the range of information that you can query. Each repository has its own set of virtual tables. Each virtual table is structured like a relational database table.

Entry Tables

  • LF.Entry table: Provides information about Laserfiche entries, such as last modified date, creator, templates, volumes, and checked-out status. This is the default table that queries without a FROM clause will be run on.
  • LF.Page table: Provides information like page numbers, images, and thumbnails.

Metadata Tables

  • LF.Pset table: Provides template information.
  • LF.Prop_value table: Provides information about fields.
  • LF.Entry_prop table: Provides information about field values. Each row in the table represents an entry, and each column represents a field. The value in the intersection of a row and a column represents the field value for that document and that field.
  • LF.Link_def table: Provides information about how a type of is defined, such as how the source and the target in the link are labeled. For example, if you are creating a type of relationship that connects an email message and its attachment, you can label the source as “Message” and the target as “Attachment”.
  • LF.Entry_Link table: Provides information about a specific link between documents, such as the IDs of the source and target documents.
  • LF.Tag_def table: Provides information about how a tag is defined, including whether it is a security tag.
  • LF.Entry_tag table: Provides information about specific tags on entries, such as the tag ID and entry ID.
  • LF.Annotation table: Provides information about annotations, such as the color, creation date, and type of annotation.

Trustee Tables

  • LF.Trustee table: Provides information on Laserfiche trustees, such as IDs and names.
  • LF.Trustee_attr table: Provides information on Laserfiche trustee attributes, which influence how the Laserfiche interface is displayed to different trustees. This table lets you look up the value of a given attribute for any trustee.

Other Tables

  • LF.Recycle_bin table: Provides information on deleted entries, like the original parent of the entry, deletion date, and deleter.
  • LF.Volume table: Provides information about the volume, like current size, name, and maximum size.

Data Types

Type Description
int Integer.
int64 64-bit integer.
decimal Decimal.
string String type; may contain Unicode characters.
path Laserfiche path; must start with \.
date ISO-8601 format date; time portion is optional.
time The time portion of an ISO-8601 format date.
blob An array of bytes.
clob An array of characters.

Tables

LF.Entry Table

Name Type Description
entry_id int 32-bit ID
entry_name string Name of the entry
link_to int The entry ID of the entry that the shortcut links to. This value is 0 if the entry is not a shortcut
created_date date Creation date (in UTC)
creator string User that created the entry
last_modified date Last modification date (in UTC)
mime_type string Electronic document MIME type
extension string Electronic document extension
type string Entry type (e.g. document, shortcut, folder, series)
page_count int Number of pages
volume_id int Volume ID
volume_name string Volume name
pset_id int Template ID
pset_name string Template name
ocr_state string none if no pages have been OCRed. some if some pages have been OCRed. all if all pages have been OCRed.
indexed int Indicates if the document has been indexed. 0 indicates no, 1 indicates yes.
needsindex int Indicates whether the document is a new document that is waiting to be indexed. 0 indicates no, 1 indicates yes.
checked_out_by string Name of user who checked out the document
checked_out_id int The ID of the user who checked out the document
version int The link number in a link group
ver_comment string Link group comment
has_page int Indicates whether the document has associated pages. 0 indicates no, 1 indicates yes.
has_edoc int Indicates whether the document contains an electronic file. 0 indicates no, 1 indicates yes.
has_text_page int Indicates whether the document has associated text pages. 0 indicates no, 1 indicates yes.
edoc blob The electronic file that is attached to the document
path path The path to the entry. This can appear only in the SELECT and ORDER BY clauses.

LF.Page Table

Name Type Description
entry_id int 32-bit ID
page_num int The page number (starting at 1)
text clob The text of the page
has_text int This is 1 if this page contains text, 0 otherwise
image blob The image of the page
has_image int This is 1 if this page contains image pages, 0 otherwise
thumbnail blob The thumbnail of the page
has_thumbnail int This is 1 if this page contains thumbnails, 0 otherwise
location blob Data linking document text to locations on page images.
has_location int This is 1 if text is linked to location on page, 0 otherwise

LF.Recycle_bin Table

Name Type Description
entry_id int 32-bit ID
orig_parent int The ID of the original parent
orig_name string The entry name before deletion
deleted date The deletion date
deleter string The user who deleted this entry

LF.Volume Table

Name Type Description
volume_id int The volume ID
volume_name string The volume name
vol_cursize int64 The current size of the volume
vol_maxsize int64 The volume’s maximum size

LF.Pset Table

Name Type Description
pset_id int Template ID
pset_name string Template name
pset_descrip string Template description

LF.Prop_value Table

Name Type Description
entry_id int 32-bit ID
prop_id int Field ID
prop_name string Field name
prop_type string The type of the field. The letter codes are as follows: S - string, D - date, A - datetime, T - time, N - number, B - blob, L - list, H - short int, I - long int
position int The position of the field value in a multi-value field; starts with 0
string_value string The string value of the field
number_value decimal The number value of the field
date_value datetime The date value of the field
binary_value blob The binary value of the field

LF.Entry_prop Table

Each row in this table represents an entry and each column represents a field that exists in the repository. The intersection of a row and a column is the value of the field that is defined by the column for the entry that is defined by the row.

Multi-value fields can be accessed by adding a suffix to the column name indicating the index of the value. For example, you may access the second value of the field author by using the identifier author[1]. The index is zero-based.

DateTime, Date, and Time fields are recorded in the local time of the Client workstation that recorded them, which means they are not in UTC.

Name Type Description
link_id int Link ID
src_label string Source label, e.g. “email”
trg_label string Target label, e.g. “attachment”
link_descrip string Link description
Name Type Description
link_id int Link ID
src_id int Source ID
trg_id int Target ID
elink_descrip string Entry link description

LF.Tag_def Table

Name Type Description
tag_id int Tag ID
tag_name string Tag name
tag_descrip string Tag description
is_secure int Indicates whether the tag is a security tag. 0 indicates no, 1 indicates yes.

LF.Entry_tag Table

Name Type Description
entry_id int Entry ID
tag_id int Tag ID
et_descrip string Entry tag description

LF.Annotation Table

Name Type Description
entry_id int Entry ID
ann_page int The page number (starting at 1) that the annotation is on
ann_color int The annotation color (decimal value)
ann_create_date date The annotation creation date (in UTC)
ann_creator string The creator of the annotation
ann_comment string Annotation comment
ann_type string Annotation type (note, stamp, redaction, or highlight)
ann_stamp_name string The stamp name if the annotation is a public stamp
sticky_note string The text of the sticky note

LF.Trustee Table

Name Type Description
trustee_id int Trustee ID
trustee_name string Trustee name
descrip string Description of the trustee
sid string Trustee SID
type string Type of Trustee. U - User, G - Group

LF.Trustee_attr Table

Name Type Description
trustee_name string Trustee’s name
attr_name string Trustee attribute name
attr_val string Trustee attribute value
sid string Trustee SID