Grass Valley K2 TX/MAM Database Protocol Manual v.2.2 - Manual (Page 2)

TX/MAM Database Protocol Manual - document version: 2.2 – Page 2
1. Grass Valley Product Support ......................................................................................................................... 3
2. About this document ........................................................................................................................................ 3
3. TX/MAM functions and syntax......................................................................................................................... 3
4. Defines ............................................................................................................................................................. 4
5. Initializing the library ....................................................................................................................................... 6
5.1 Initializing the library to use a local playout database ............................................................................ 6
5.2 Initializing the library to use a remote database ..................................................................................... 7
6. Database search functions .............................................................................................................................. 8
6.1 Clearing all criteria used in a previous search ......................................................................................... 8
6.2 Adding a criterion that defines a restriction for integer database fields ................................................... 9
6.3 Adding a criterion that defines a restriction for int64 (='long long') database fields .............................. 10
6.4 Adding a criterion that defines a restriction for string database fields ................................................... 11
6.5 Adding a criterion that contains a SQL-query ....................................................................................... 12
6.6 Adding a criterion that contains a parameter for a previously added SQL-query .................................. 13
6.7 Retrieving the list of IDs that are the result of evaluating the previously added criteria ....................... 14
7. Retrieve functions ......................................................................................................................................... 15
7.1 Clearing all requests for fields that may have been used in a previous retrieve call ............................. 15
7.2 Adding a field request for an integer database field ............................................................................. 16
7.3 Adding a field request for an int64 (= long long) database field ............................................................ 17
7.4 Adding a field request for a string database field ................................................................................. 18
7.5 Adding a field request for a text blob database field .............................................................................. 19
7.6 Retrieving the requested fields for the record with id == id and from the table == table ....................... 20
8. Update functions ........................................................................................................................................... 21
8.1 Adding a field update for an integer database field ............................................................................... 21
8.2 Adding a field update for an int64 (= long long) database field ............................................................. 22
8.3 Adding a field update for a string database field.................................................................................... 23
8.4 Adding a field update for a text blob database field ............................................................................... 24
8.5 Updating the record (from table with ID) with the previously added field values .................................. 25
8.6 Creating a record in the table with previously added fieldvalues .......................................................... 26
8.7 Creating the assetjobs, asset_index and group_access records for an asset in the
database ............................................................................................................................................................ 27
8.8 Deleting a record (indicated by the ID) from a table .............................................................................. 28
9. Finalization functions .................................................................................................................................... 29
9.1 Cleaning up the library ........................................................................................................................... 29
10. Date & time functions ................................................................................................................................. 30
10.1 Converting a Cobalt time field to two strings containing resp. the time and date part .......................... 30
10.2 Converting human readable time and date string to a Cobalt time field ............................................... 31
10.3 Getting the current system time and converting to a Cobalt time field .................................................. 32
11. Scheduling functions ................................................................................................................................. 33
11.1 Creating a new main event with import fields and formats ....................................................................... 33
11.2 Checking if the asset indicated by asset_id is in a schedule with the time indicated by
start_timedate and end_timedate ...................................................................................................................... 36
12. Utility functions........................................................................................................................................... 37
12.1 Returning the current library version ...................................................................................................... 37
Copyright © Grass Valley USA, LLC. All rights reserved. This product may be covered by one or
more U.S. and foreign patents.