Helix Search: Data model

This section details the three data models used by Helix Search.

ChangeModel

One instance of this represents one change in the Helix server.

Name Description Type
type Fixed string "change" String
change Helix server change number Long
date Change date Long
client Helix server client name String
user Helix server user String
restricted Whether the change is restricted or not Boolean
description Change description String
depotFile Depot file path String

ContentModel

One instance of this represents contents of one changed file in the Helix server:

Name Description Type
type Fixed string "content" String
depotFile Depot file path String
rev Helix server revision number Integer
change Helix server change number Long
date Change date Long
fileName File name String
fileSize File size in bytes Long
fileType File type, for example: text, binary, symlink, unicode, utf8, utf16. For more information on filetypes, see File Types in the Helix Core Command-Line (P4) Reference. String
action Helix server action, for example: add and edit String
user User that submitted the change String
contentType Content type detected by the Tika library String
content The content of the file indexed by the Tika library String
blur The BlurHash for the thumbnail String

RevisionModel

One instance of this represents one revision of a file in the Helix server:

Name Description Type
type Fixed string "revision" String
change Helix server change number Long
date Change date Long
depotFile Depot file path String
action Helix server action,for example: add and edit String
fileType File type, for example: text, binary, symlink, unicode, utf8, utf16. For more information on filetypes, see File Types in the Helix Core Command-Line (P4) Reference. String
rev Helix server revision number Integer
fileSize File size in bytes Long
digest An MD5 digest of the file represented by a 32 heaxadecimal digit string String