Home
Other docs
WEB Core API
adminUI API
Tutorials
00 Server architecture
01 Build-in HTTP server
WebSockets
02 Security
UB schema
UBIP schema
OpenID Connect
03 Delayed operations
Schedulers
04 OData
05 DocuSign
06 Other(work in progress)
Entites
Primary keys
Row level security
Full text search
Web DAV access
Report generation
Messages with guaranteed delivery
Using UnityBase modules
Modules
@unitybase/base/argv
getConfigFileName
serverSessionFromCmdLineAttributes
establishConnectionFromCmdLineAttributes
checkServerStarted
getServerConfiguration
serverURLFromConfig
safeParseJSONfile
findCmdLineSwitch
findCmdLineSwitchValue
ServerSession
logout
HOST
USER
PWD
uData
connection
appInfo
@unitybase/base/csv1
parse
@unitybase/base/CustomRepository
CustomRepository
using
attrs
where
exists
notExists
correlation
logic
join
joinCondition
orderBy
orderByDesc
groupBy
start
limit
describe
ubql
selectAsObject
selectAsArray
selectAsStore
select
selectSingle
selectScalar
selectById
misc
withTotal
@unitybase/base/dataLoader
loadSimpleCSVData
loadArrayData
localizeEntity
lookup
@unitybase/base/FileBasedStoreLoader
parseFolder
FileBasedStoreLoader
load
config
attributes
haveModifyDate
haveCreateDate
processingRootFolder
resultCollection
@unitybase/base
argv
CustomRepository
LocalDataStore
options
ServerRepository
UBConnection
UBDomain
UBSession
csv
dataLoader
FileBasedStoreLoader
Worker
uba_common
@unitybase/base/LocalDataStore
doFilterAndSort
byID
doFiltration
doSorting
selectResultToArrayOfObjects
flatten
arrayOfObjectsToSelectResult
@unitybase/base/options
describe
switchIndex
switchValue
Options
add
parse
parseVerbose
usage
@unitybase/base/ServerRepository
fabric
ServerRepository
selectAsObject
selectAsArray
selectAsStore
select
selectSingle
selectScalar
selectById
ubRequest
WhereCondition
@unitybase/base/UBConnection
UBConnection
getAppInfo
getDomainInfo
isAuthorized
userLogin
userLang
userData
lookup
query
xhr
get
post
runCustom
run
logout
setDocument
insert
Repository
_domain
clientRequest
servicePath
appName
onRequestAuthParams
queryMethod
encryptContent
serverCertificate
sessionKeyLifeTime
authMethods
authNeed
appConfig
@unitybase/base/UBDomain
UBDomain
isEntityMethodsAccessible
get
has
eachEntity
filterEntities
getPhysicalDataType
entities
connections
models
forceMIMEConvertors
ubDataTypes
ExpressionType
ubMixins
ubServiceFields
EntityDataSourceType
EntityCacheTypes
dialectsPriority
UBModel
name
needInit
needLocalize
order
moduleName
clientRequirePath
realPublicPath
UBEntityAttributes
asJSON
UBEntityMapping
selectName
execName
pkGenerator
UBEntity
getEntityCaption
attr
getAttribute
eachAttribute
mixin
hasMixin
checkMixin
haveAccessToMethod
filterAttribute
haveAccessToAnyMethods
haveAccessToMethods
getConvertRules
getDescriptionAttribute
getEntityAttributeInfo
getEntityAttribute
getAttributeNames
getEntityRequirements
checkAttributeExist
getEntityDescription
code
modelName
name
sqlAlias
connectionName
isFTSDataTable
connectionConfig
mapping
dbKeys
dbExtensions
attributes
mixins
entityMethods
caption
description
documentation
descriptionAttribute
cacheType
dsType
UBEntityAttributeMapping
expressionType
expression
UBEntityAttribute
getAssociatedEntity
code
name
dataType
associatedEntity
associationAttr
caption
description
documentation
size
allowNull
allowSort
isUnique
defaultValue
readOnly
isMultiLang
cascadeDelete
enumGroup
customSettings
associationManyData
storeName
generateFK
defaultView
mapping
physicalDataType
UBEntityMixin
code
UBEntityStoreMixin
simpleAudit
safeDelete
UBEntityHistoryMixin
historyType
UBEntityAclRlsMixin
UBEntityFtsMixin
scope
dataProvider
UBEntityAlsMixin
alsOptimistic
@unitybase/base/UBSession
UBSession
signature
isAnonymous
authHeader
hexa8
crc32
userData
authSchema
@unitybase/base/worker
Worker
getMessage
waitMessage
terminate
postMessage
assert
fail
ok
equal
notEqual
deepEqual
notDeepEqual
throws
doesNotThrow
ifError
buffer
newBufferWarned
console
Console
log
debug
info
warn
error
dir
time
timeEnd
assert
events
fs
isFile
isDir
loadFile
readFileSync
mkdirSync
readdirSync
statSync
writeFileSync
appendFileSync
existsSync
unlinkSync
rmdirSync
renameSync
ReadStream
http
setGlobalProxyConfiguration
setGlobalConnectionDefaults
request
buildURL
get
STATUS_CODES
ClientRequest
setHeadersAsString
end
setPath
setMethod
setHeader
getHeader
removeHeader
write
IncomingMessage
setEncoding
read
encoding
statusCode
https
module
os
path
querystring
parse
stream
string_decoder
tty
url
util
format
inspect
isBoolean
isNull
isNullOrUndefined
isNumber
isString
isSymbol
isUndefined
isRegExp
isObject
isDate
isFunction
isPrimitive
log
inherits
print
puts
debug
error
isArray
isError
isBuffer
vm
runInThisContext
@unitybase/ub/web-sockets
registeredProtocols
getWSNotifier
WebSocketTransport
JsonMessagesProtocol
sendCommand
getUserSessions
broadcast
@unitybase/ubcli/autotest
@unitybase/ubcli/checkServerNotStarted
@unitybase/ubcli/createCodeInsightHelper
namedCollection2Array
@unitybase/ubcli/createStore
@unitybase/ubcli/ftsReindex
@unitybase/ubcli/generateDDL
@unitybase/ubcli/generateDoc
@unitybase/ubcli/initDB
@unitybase/ubcli/initialize
@unitybase/ubcli/prepareGZIP
@unitybase/ubcli/upgradeConfig
@unitybase/http-proxy
HttpProxy
processRequest
@unitybase/canvas
UBCanvas
createNew
setFont
drawText
measureText
drawImage
saveToFile
getContent
freeNative
FontStyles
TextFormats
@unitybase/com-bridge
createCOMObject
@unitybase/mailer
TubMailReceiver
TubMailSender
TubSendMailBodyTypeBind
TubSendMailAttachKindBind
TubMailReceiverBind
getMessagesCount
getMessageSize
receive
top
deleteMessage
reconnect
TubMailSenderBind
sendMail
TubMimeMessBind
messagePart
fullText
header
StringCollectionBind
readLn
read
byteLength
linesCount
TMessHeaderBind
from
toList
cCList
subject
organization
customHeaders
date
xMailer
replyTo
messageID
priority
charsetCode
TMimePartBind
primary
encoding
charset
defaultCharset
primaryCode
encodingCode
charsetCode
targetCharset
convertCharset
forcedHTMLConvert
secondary
description
disposition
contentID
boundary
fileName
lines
partBody
headers
prePart
postPart
subLevel
maxSubLevel
attachInside
maxLineLength
subPart
@unitybase/openid-connect
registerOpenIDEndpoint
openIDConnect
@ub-e/odata
registerEndpoint
ODataEndpoint
handle
metadata
notFoundError
checkEntitySet
queryByID
query
collections
update
Namespaces
process
cwd
nextTick
binPath
configPath
isServer
isWebSocketServer
isWebSocketEnabled
isDebug
startupMode
UB
UBAbort
ns
format
Repository
i18n
isServer
App
preventDefault
registerEndpoint
addAppLevelMethod
serviceMethodByPassAuthentication
resolveStatic
fileChecksum
folderChecksum
globalCacheGet
globalCachePut
authFromRequest
els
getUISettings
deleteFromFTSIndex
updateFTSIndex
dbInTransaction
dbCommit
dbRollback
dbStartTransaction
name
staticPath
serverURL
localIPs
domain
domainInfo
defaultDatabase
customSettings
emitterEnabled
serverPublicCert
serverConfig
databases_
defaultDatabase_
Session
setUser
runAsAdmin
runAsUser
id
userID
userRoles
userRoleNames
userLang
uData
callerIP
RLS
userInGroup
currentUserInGroup
userInAdmSubtable
currentStaffUnitInDocAdmSubtable
currentSender
currentReceiver
userOrUserGroupInAdmSubtable
virtualStores
Custom
saveContentToTempStore
moveToArchive
deleteContent
loadContentFromTempStore
moveToPermanentStore
fillResponse
loadBodyFromEntity
getTempFileName
fileVirtual
saveContentToTempStore
moveToArchive
deleteContent
loadContentFromTempStore
moveToPermanentStore
fillResponse
loadBodyFromEntity
getRevisionConfig
setRevisionIsPermanent
tempContentExists
fileVirtualWritePDF
saveContentToTempStore
mdb
fillResponse
saveContentToTempStore
loadContentFromTempStore
loadBodyFromEntity
moveToArchive
deleteContent
moveToPermanentStore
Classes
TubList
clear
setBLOBValue
byName
asJSON
count
items
strings
TubZipReader
unZipToBuffer
unZipToDir
unZipAllToDir
fileNames
fileCount
TubZipWriter
addBuffer
addFile
freeNative
TubConnectionConfig
dialect
supportLang
TubEntityAttributeList
byName
asJSON
count
items
strings
TubEntity
addMethod
name
modelName
caption
description
connectionName
connectionConfig
connection
cacheType
dsType
sqlAlias
descriptionAttribute
documentation
idGenerator
attributes
existSequence
refSequenceName
allowGenSequence
allowUseSequence
TubDataStore
run
runSQL
execSQL
initFromJSON
fieldIndexByName
get
getAsBuffer
next
prev
first
last
generateID
freeNative
initialize
bof
eof
entity
initialized
asJSONObject
asJSONArray
asXMLPersistent
currentDataName
rowCount
totalRowCount
rowPos
TubNamedCollection
byName
asJSON
count
items
strings
ubMethodParams
preventDefault
skipOptimisticLock
dataStore
originalParams
mParams
externalCall
THTTPRequest
read
headers
method
url
uri
decodedUri
parameters
decodedParameters
body
THTTPResponse
writeHead
writeBinaryBase64
writeEnd
validateETag
write
statusCode
TubDocumentContent
TubDocumentRequest
createHandlerObject
saveBodyToFile
loadBodyFromFile
getBodyAsUnicodeString
setBodyAsUnicodeString
setBodyFromArrayBuffer
getBodyAsBase64String
getIsBodyLoaded
setContent
getContent
writeToTemp
entity
attribute
id
isDirty
forceMime
fileName
TubDocumentHandlerCustom
loadContent
attribute
request
storeConfig
content
WebSocketConnection
send
close
session
TubDatabase_
startTransaction
commit
rollback
run
exec
genID
inTransaction
Interfaces
UBReader
read
UBWriter
write
Events
exit
domainIsLoaded
login
registration
newUserRegistration
loginFailed
securityViolation
connect
disconnect
Mixins
EventEmitter
setMaxListeners
getMaxListeners
emit
addListener
on
once
removeListener
removeAllListeners
listeners
listenerCount
Global
spawn
punycode
require
sleep
setImmediate
console
removeCommentsFromJSON
forceDirectories
removeDir
createGuid
gc
ncrc32
nsha256
TubLoadContentBody
TubAttrDataType
TubCacheType
TubSQLDialect
TubEntityDataSourceType
TubSQLExpressionType
_
models
clientRequire
getAppInfo
getDomainInfo
UBEntityMapping
@unitybase/base/UBDomain
~
UBEntityMapping
new
UBEntityMapping
()
Members
selectName
:
string
execName
:
string
pkGenerator
:
string