Documentation API PYTHON

From RLIB

Jump to: navigation, search

Contents

Initialization, cleanup

All RLIB using Python code starts with this directive:

    import rlib

rlib.Rlib()

Allocating a report structure is done by this call:

    myreport = rlib.Rlib()

Cleanup

There's no explicit cleanup call as rlib_free() in the C API. This is done automatically when the above variable is deallocated.

rlib.version

Queries the RLIB version.

    print rlib.version

Datasource definition

Python specific call:

    rlib.add_datasource_array(dsn)

dsn is the name of the datasource.

For the parameters of these calls below, see the C API Datasource definition.

    rlib.add_datasource_mysql()
    rlib.add_datasource_odbc()
    rlib.add_datasource_postgres()
    rlib.add_datasource_xml()
    rlib.add_datasource_csv()

Query definition

For the parameters of this call below, see the C API Query definition.

    rlib.add_query_as()

Report XML definition

For the parameters of these calls below, see the C API Report XML definition.

    rlib.add_report()
    rlib.add_report_from_buffer()

Output control

For the parameters of these calls below, see the C API Output control.

    rlib.set_output_format()
    rlib.set_output_format_from_text()
    rlib.set_output_parameter()
    rlib.set_locale()
    rlib.set_output_encoding()
    rlib.set_datasource_encoding()
    rlib.execute()
    rlib.get_content_type_as_text()
    rlib.spool()
    rlib.get_output()
    rlib.get_output_length()

Report control

For the parameters of these calls below, see the C API Report control.

    rlib.add_function()
    rlib.signal_connect()
    rlib.signal_connect_string()
    rlib.add_parameter()
    rlib.add_resultset_follower_n_to_1()
    rlib.add_resultset_follower()
    rlib.query_refresh()
    rlib.graph_add_bg_region()
    rlib.graph_clear_bg_region()
    rlib.graph_set_x_minor_tick()
    rlib.graph_set_x_minor_tick_by_location()
Personal tools