BioStar 2

Database Table

Version 2.6.0

Video Extension

@2018 by Suprema Inc.

 BioStar2 V2.6.0 – Database Table

Table of Contents
Revision Note..................................................................................................................... 4
BioStar 2.6......................................................................................................................... 4
BioStar 2.5......................................................................................................................... 4
Highlight index.................................................................................................................. 4
Cautions.............................................................................................................................. 5
Generic Cautions............................................................................................................... 5
BioStar 2 Database Related Cautions................................................................................ 6
Table Information............................................................................................................. 7
COL_SETTING : Column Setting for List UI.......................................................................7
DEVICE : Devices.............................................................................................................. 7
DEVICEGROUP : Device Group........................................................................................ 8
DOOR: Door...................................................................................................................... 8
DOORGROUP : Door Group.............................................................................................. 8
EVENTLOG : Event Log..................................................................................................... 9
EVENTSYNC : Event Type................................................................................................ 9
EVENTTYPE : Event Type............................................................................................... 10
HOLIDAY : Holiday Schedule.......................................................................................... 11
HOLIDAYDATE : Holiday Schedule Date Information.....................................................11
TSHOLIDAYTIMESEGMENT : Time Segments of Holiday Schedule Date Information. .11
IPCAMERA : IP Camera.................................................................................................. 12
NVR : NVR....................................................................................................................... 13
RCDPTH : Record Path................................................................................................... 13
RECORDLOG : Record Log............................................................................................. 14
ROLECODE : Role Code for one User..............................................................................14
SECUREDATA : Secure Data.......................................................................................... 15
SYSTEMSETTING : System Setting................................................................................ 16
TIMESCHEDULE : Time Schedule.................................................................................. 16
TIMESCHEDULETIMESEGMENT : Time Segments of Time Schedule...........................17
TR_EVT : Trigger Event to Record Video/Snapshot Data................................................17
USER : User.................................................................................................................... 18
USERGROUP : User Group............................................................................................. 18
USERSESSION : User Session........................................................................................ 19
VESESSION : Video Extension Session...........................................................................19

© 2018 by Suprema Inc. 2

 BioStar2 V2.6.0 – Database Table

© 2018 by Suprema Inc. 3

 BioStar2 V2.6.0 – Database Table

Revision Note
BioStar 2.6
- Video is supported in MSSQL DB
- RC_SP, space_rate_to_alert, record_mode added in SYSTEMSETTING table

BioStar 2.5
- Video is supported in Maria DB

Highlight index
Added Color
Version
BioStar 2.6

© 2018 by Suprema Inc. 4

 BioStar2 V2.6.0 – Database Table

Cautions
Generic Cautions
A. Isolation Level
If tx_isolation in Maria DB’s Global/Session variable is REPEATABLE READ avoid using
INSERT INTO ~, SELECT ~, CREATEA TABLE AS ~ SELECT ~
a. Alternative: Configure and use tx_isolation as READ UNCOMMITTED or READ
COMMITTED.
b. Reference: Isolation Level

B. Multiple Sessions
Avoid using REPLACE INTO ~ with multiple DB sessions. The REPLACE INTO ~ operation
executes two operations of DELETE ~ and INSERT INTO ~ as one operation and when this
status is linked with the isolation level mentioned above, a dead-lock may occur.
a. Alternative: Use INSERT INTO ~ ON DUPLICATE KEY UPDATE ~
b. Reference 1: Replace
c. Reference 2: INSERT on duplicate key update

C. Self-reference
Self-reference should not be used if possible when executing an update or insert query. If a
self-referencing SELECT statement is included in an update or insert query, many locks will
be held which may lead to performance decrease. Furthermore, a reference to a table with a
foreign key constraint may also provide a similar result as a self-reference.
a. Example 1: UPDATE T_USR SET NM = (SELECT NM FROM T_USR WHERE USRID =
'1111');
b. Example 2: INSERT INTO T_USR (A, B, C, D) SELECT 'a', 'b', 'c', D FROM T_USR;

D. Transactions
Transactions (batch jobs) should be held shortly as possible unless it is an insert and update
execution for a large number of rows.

E. DDL Usage
DDL usage within a transaction will execute an implicit commit which may result in
unintended results. (Rollback is not possible)
a. Reference 1: SQL statements That Cause an Implicit Commit

© 2018 by Suprema Inc. 5

 BioStar2 V2.6.0 – Database Table

BioStar 2 Database Related Cautions

A. Allowed Tables
Usage of any other table not included in the Table Information section of this document is
not allowed.

B. Auto Sync Tables

There is two kind of table which Synchronized with BioStar. Or not
a. COL-SETTING, EVENTSYNC, IPCAMERA, NVR, RCDPTH, RECORDLOG, TR_EVT are not sync
data.
b. Lest data is sync data or not allowed.

© 2018 by Suprema Inc. 6

 BioStar2 V2.6.0 – Database Table

Table Information
[CAUTION] : Please do NOT manually modify any INTERNAL data in your database.

COL_SETTING : Column Setting for List UI

Column Data Type Key Description
ID UNSIGNED INT PK Unique ID (INTERNAL)
CK TINYINT Show / Hide = 1 / 0
KEY VARCHAR(255) Message Text or Message Key for UI
MSG_DB TINYINT Message Key Mode for Key field – Boolean
1: KEY field is message key
0: KEY field is message text
INDEX INT Order on UI List
WIDTH INT Column Width
LT_NE VARCHAR(10) List Name for Distinguish Target List on UI
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
USER_ID VARCHAR(255) User ID of this setting

DEVICE : Devices
Column Data Type Key Description
ID VARCHAR(255) PK Unique Device ID
NAME VARCHAR(255) Name
IP_ADDRESS VARCHAR(50) IP address
TYPE VARCHAR(40) Device Type
STATUS_COD VARCHAR(10) Status Code = AC (active)/IN (inactive)
E
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
DG_ID INT Device Group ID That this device belongs to
1: global
2: Not null
PDV_ID VARCHAR(255) Parent Device ID That this device belongs to
Not null

© 2018 by Suprema Inc. 7

 BioStar2 V2.6.0 – Database Table

DEVICEGROUP : Device Group

Column Data Type Key Description
ID UNSIGNED INT PK Unique Device ID
NAME VARCHAR(255) Name
DEPTH INT Device Group Tree Depth Level
0: All Devices
1~: depth
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
PDG_ID UNSIGNED INT Parent Device Group ID of this group

DOOR: Door
Column Data Type Key Description
ID UNSIGNED INT PK Unique Door ID
NAME VARCHAR(255) Name
STATUS_CODE VARCHAR(10) Status Code = AC (active)/IN (inactive)
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
DG_ID UNSIGNED INT Door Group ID of this Door
ENTRY_DEVICE_I VARCHAR(255) Entry Device ID on this Door
D
EXIT_DEVICE_ID VARCHAR(255) Exit Device ID on this Door
RELAY_DEVICE_ID VARCHAR(255) Relay Device ID on this Door
SENSOR_DEVICE_ VARCHAR(255) Sensor Device ID on this Door
ID
BUTTON_DEVICE_ VARCHAR(255) Button Device ID on this Door
ID

DOORGROUP : Door Group

Column Data Type Key Description
ID UNSIGNED INT PK Unique Door ID
NAME VARCHAR(255) Name
DEPTH INT Door Group Tree Depth Level
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
PDG_ID UNSIGNED INT Parent Door Group ID of this group

© 2018 by Suprema Inc. 8

 BioStar2 V2.6.0 – Database Table

EVENTLOG : Event Log

Column Data Type Key Description
ID UNSIGNED PK Unique ID
BIGINT(20)
DV_DT DATETIME Date/time from Device
DV_ID VARCHAR(255 Device ID
)
DR_ID INT Door ID
CH_ID INT NVR Channel ID
BS_EVT_CD INT BioStar Event Code
BS_EVT_ID INT BioStar Event ID
BS_EVT_DT DATETIME BioStar Event Date/Time
USER_ID VARCHAR(255 User ID
)
BS_EVT_M VARCHAR(10) Month of BioStar Event
BS_EVT_LI INT Index of BioStar Event
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time

EVENTSYNC : Event Type

Column Data Type Key Description
ID INT(11) PK Unique Event Sync ID
ST_DT DATETIME Event Sync Start Time
END_DT DATETIME Event Sync End Time
EMPTY_RUN_COUN Count for Search request result empty
INT(11)
T
LAST_QUERY_END_ Date/time of last search request
DATETIME
DT
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
VARCHAR(255 Device id of this event sync
DV_ID
)

© 2018 by Suprema Inc. 9

 BioStar2 V2.6.0 – Database Table

EVENTTYPE : Event Type

Column Data Type Key Description
INT(11) PK Unique ID
CODE
UNSIGNED
NAME VARCHAR(50) name
DESCRIPTIO VARCHAR(255 Description
N )
STATUS_COD Status Code = AC (active)/IN (inactive)
VARCHAR(10)
E
ALERTABLE TINYINT(1) Is set alert mode as boolean
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time

© 2018 by Suprema Inc. 10

 BioStar2 V2.6.0 – Database Table

HOLIDAY : Holiday Schedule

Column Data Type Key Description
INT(11) PK Unique ID
ID
UNSIGNED
NAME VARCHAR(50) Name
DSCR TEXT Description
BIOSTAR_ID INT(11) Holiday ID from BioStar
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time

HOLIDAYDATE : Holiday Schedule Date Information

Column Data Type Key Description
INT(11) PK Unique ID
ID
UNSIGNED
REPETITION_TY Repetition type of holiday
VARCHAR(30)
PE
DATE VARCHAR(30) Holiday Date
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
INT(11) Holiday Schedule ID
HOLIDAY_ID
UNSIGNED

TSHOLIDAYTIMESEGMENT : Time Segments of Holiday Schedule Date

Information
Column Data Type Key Description
START_TIME INT(11) Start Time of time segment
END_TIME INT(11) End Time of time segment
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
INT(11) Time Schedule ID of this
TSID
UNSIGNED

© 2018 by Suprema Inc. 11

 BioStar2 V2.6.0 – Database Table

IPCAMERA : IP Camera
Column Data Type Key Description
INT(11) PK Unique ID
ID
UNSIGNED
VARCHAR(255 Name
NAME
)
INT(4) NVR Channel ID of this
CHANNEL
UNSIGNED
IP_ADDRESS VARCHAR(50) IP Address
LOG_TYPE VARCHAR(10) Video/Snapshot
VIDEO_LOG_FROM_S INT(4) Recording video start-time from Event
EC UNSIGNED occurs
INT(4) Recording video end-time from Event
VIDEO_LOG_TO_SEC
UNSIGNED occurs
IMAGE_LOG_SEC INT(11) Record at this(seconds) from Event occurs
OFF_COVER_HOUR INT(11) TDB
STREAM_PROFILE INT(11) TDB
STREAM_PROFILE_N VARCHAR(255 TDB
M )
STATUS_CODE VARCHAR(10) Status Code = AC (active)/IN (inactive)
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
INT(11) NVR ID of NVR of This
NVR_ID
UNSIGNED
INT(11) Door ID of Door That this belongs to
DR_ID
UNSIGNED

© 2018 by Suprema Inc. 12

 BioStar2 V2.6.0 – Database Table

NVR : NVR
Column Data Type Key Description
INT(11) PK Unique ID
ID
UNSIGNED
VARCHAR(255 NVR Make
MAKE
)
VARCHAR(255 Name
NAME
)
IP_ADDRESS VARCHAR(50) IP Address
INT(10) IP Port
PORT
UNSIGNED
VARCHAR(255 Login ID for NVR
LOGIN_USER_ID
)
VARCHAR(255 Password for NVR
LOGIN_PASSWORD
)
Default Record type for Child IP Cameras,
LOG_TYPE VARCHAR(10)
values Video/Snapshot
VIDEO_LOG_FROM_S INT(4) Default Video Record Start time from Event
EC UNSIGNED time
INT(4) Default Video Record End time from Event
VIDEO_LOG_TO_SEC
UNSIGNED time
IMAGE_LOG_SEC INT(4) Default Snapshot time from Event time
STATUS_CODE VARCHAR(10) Status Code = AC (active)/IN (inactive)
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time

RCDPTH : Record Path

Column Data Type Key Description
BIGINT(20) PK Unique ID
ID
UNSIGNED
VARCHAR(255 Path String of storage
PATH
)
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time

© 2018 by Suprema Inc. 13

 BioStar2 V2.6.0 – Database Table

RECORDLOG : Record Log

Column Data Type Key Description
BIGINT(20) PK Unique ID
ID
UNSIGNED
INT(11) NVR ID of this Record
NVR_ID
UNSIGNED
CHANNEL_N TINYINT(4) NVR Channel ID of this Record
O UNSIGNED
BIGINT(20) Request ID which indicate Event log (eventlog
REQ_ID
UNSIGNED table ID)
INT(11) Event code (eventtype table CODE)
EVT_CD
UNSIGNED
DL CHAR(1) Storage Drive Letter (if set zero, deleted file)
VARCHAR(255 Record file name
REC_FILE
)
REC_FILE_SIZ Record file size
BIGINT(11)
E
REC_FILE_DT DATETIME Record file date/time
VARCHAR(255 Thumbnail file name
TMB_FILE
)
TMB_FILE_SI BIGINT(11) Thumbnail file size
ZE UNSIGNED
TMB_FILE_DT DATETIME Created date/time
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
PATH_ID BIGINT(20) RECPTH ID of this

ROLECODE : Role Code for one User

Column Data Type Key Description
INT(11) PK Unique ID
ID
UNSIGNED
CODE VARCHAR(50) Role Code
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
VARCHAR(255 User ID which has this role
USER_ID
)

© 2018 by Suprema Inc. 14

 BioStar2 V2.6.0 – Database Table

SECUREDATA : Secure Data

Column Data Type Key Description
INT(11) PK Unique ID
ID
UNSIGNED
HOST_PRIVATE_KEY TEXT
HOST_CERTIFICATION TEXT
RSA_PRIVATE_KEY TEXT
RSA_PUBLIC_KEY TEXT
BIOSTAR2_PUBLIC_KEY TEXT
DEFAULT_ADMIN_ACCOU
TEXT
NT
VARCHAR(255
SESSION_SECRET
)
VARCHAR(255
SYSTEM_SALT
)
VARCHAR(255
ENCRYPTION_KEY
)
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time

© 2018 by Suprema Inc. 15

 BioStar2 V2.6.0 – Database Table

SYSTEMSETTING : System Setting

Column Data Type Ke Description
y
INT(11) PK Unique ID
ID
UNSIGNED
VARCHAR(255
BIOSTAR_SERVER_URL
)
VARCHAR(255
PASSWORD_STRENGTH_LEVEL
)
VARCHAR(255
EXT_SYSTEM_ID
)
VARCHAR(255
EXT_SYSTEM_SESSION_ID
)
VARCHAR(255
EXT_SYS_BIOSTAR_SESSION_ID
)
EXT_SYS_SESSION_UDT_DATETIM
DATETIME
E
MAX_BK_DATE_DAYS_FOR_EVT_S
INT(11)
YNC
SEARCH_LIMIT_FOR_USER_SYNC INT(11)
LAST_UDT_VER_FOR_USER_SYNC INT(11)
IS_COMPLETE_USER_SYNC TINYINT(1)
IS_COMPLETE_EVENT_SYNC TINYINT(1)
RC_SP FLOAT Reserved Space for record
space_rate_to_alert SMALLINT(5) Unused
Recording Mode
record_mode SMALLINT(5) 1: Circular Queue Mode
2: Stop on Record Space is full
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
BIGINT(20) Current record path ID
PATH_ID
UNSIGNED

TIMESCHEDULE : Time Schedule

Column Data Type Key Description
VARCHAR(255 name
NAME
)
VARCHAR(255 Repetition type string
TYPE
)
BIOSTAR_ID INT(11) PK Schedule ID from BioStar
NUM_OF_DAY Duration day
INT(11)
S
DSCR TEXT Description
START_DATE DATETIME Start date of this schedule
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time

TIMESCHEDULETIMESEGMENT : Time Segments of Time Schedule

Column Data Type Key Description
DAY_INDEX INT(11) Date Index of One Week
START_TIME INT(11) Start time

© 2018 by Suprema Inc. 16

 BioStar2 V2.6.0 – Database Table

END_TIME INT(11) End time

CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
TSID INT(11) Time Schedule ID

TR_EVT : Trigger Event to Record Video/Snapshot Data

Column Data Type Key Description
BIGINT(20) PK Unique ID
ID
UNSIGNED
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
INT(11) Event Type Code what trigger recording
EVT_TYP_CD
UNSIGNED
TSC_ID INT(11) Time Schedule ID
INT(11) Target IP Camera ID
IP_CAM_ID
UNSIGNED

© 2018 by Suprema Inc. 17

 BioStar2 V2.6.0 – Database Table

USER : User
Column Data Type Key Description
VARCHAR(255 PK Unique ID
USER_ID
)
VARCHAR(255 Name
NAME
)
BIRTH_DATE DATETIME NOT Used
ST_DT DATETIME Start date/time
EXP_DT DATETIME Expire date/time
VARCHAR(255 NOT Used
GENDER_CODE
)
VARCHAR(255 Login ID
LOGIN_ID
)
VARCHAR(255
PASSWORD
)
PASSWORD_EXIST TINYINT(1)
VARCHAR(255
MOBILE_PHONE
)
VARCHAR(255 NOT Used
EMAIL
)
PHOTO_EXIST TINYINT(1) NOT Used
VARCHAR(255 NOT Used
PHOTO
)
PHOTO_DOWNLOADE NOT Used
TINYINT(1)
D
STATUS_CODE VARCHAR(10) Status Code = AC (active)/IN (inactive)
LAST_UPDATE_VERSI Figure out update or not
INT(11)
ON
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
BIGINT(20) Parent User Group ID
UG_ID
UNSIGNED

USERGROUP : User Group

Column Data Type Key Description
BIGINT(20) PK Unique ID
ID
UNSIGNED
VARCHAR(255 Name
NAME
)
DEPTH INT(11) User Group Tree depth Level
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time
BIGINT(20) Parent User Group ID
PUG_ID
UNSIGNED

© 2018 by Suprema Inc. 18

 BioStar2 V2.6.0 – Database Table

USERSESSION : User Session

Column Data Type Key Description
ID BIGINT(20) PK Unique ID
VARCHAR(255 User ID
USER_ID
)
VARCHAR(255 Name
USER_NAME
)
VARCHAR(255 Session ID
SESSION_ID
)
BIOSTAR_SESSION_ VARCHAR(255 Biostar Session ID
ID )
LOGOUT_DATE_TIM Logout date/time
DATETIME
E
VARCHAR(255 Language setting
LANGUAGE
)
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time

VESESSION : Video Extension Session

Column Data Type Key Description
VARCHAR(255 PK Unique ID
SID
)
DATA TEXT Data
EXPIRES DATETIME Expire date/time
CREATEDAT DATETIME Created date/time
UPDATEDAT DATETIME Updated date/time

© 2018 by Suprema Inc. 19