#!/usr/bin/env python
"""

The problem: One wants to hold an XML in CCDB. But 'add' command allows only to load tabled files.
             How to load the XML to the database?

The solution: use python API to load such custom data to CCDB


Suppose we want to store xml file content in CCDB
we created the table with one string column and one row for it

to create a test table use command:
[shell]> ccdb mktbl /test/test_vars/custom_data -r 1 xml_data=string "#Store xml in ccdb"

to check the table exists
[shell]> ccdb info /test/test_vars/custom_data

** n.b. here are the commands I used to create the Translation table  2/19/2014 DL **
[shell]> ccdb mkdir Translation
[shell]> ccdb mktbl /Translation/DAQ2detector -r 1 tt_xml=string "#Translation table from DAQ to detector coordinates"


Now, how to add data...
"""
import ccdb
import io


if __name__ == "__main__":

    #create CCDB api class
    provider = ccdb.AlchemyProvider()                        # this class has all CCDB manipulation functions
    #provider.connect("mysql://ccdb_user@hallddb.jlab.org/ccdb")     # use usual connection string to connect to database
    provider.connect("sqlite:////u/home/sdobbs/Calibrations/tables/CDC/ccdb.sqlite")     # use usual connection string to connect to database
    provider.authentication.current_user_name = "sdobbs"  # to have a name in logs

    #read file
    content = io.open("header", "r").read()

    #prepare content
    #create_assignment accepts tabled data
    #rows and columns number must correspond to table definition
    tabled_data = [[content]]

    #add data to database
    provider.create_assignment(
        data=tabled_data,
        path="/CDC/cdc_gas_drift_info",
        variation_name="CDC_8mm_0T",
        min_run=0,
        max_run=ccdb.INFINITE_RUN,
        comment="")

    #that is it.
    #check it with
    #[shell]> ccdb vers /test/test_vars/custom_data