Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OpenXPKI::Server::DBI:User(Contributed Perl DocumOpenXPKI::Server::DBI::DBH(3)

Name
       OpenXPKI::Server::DBI::DBH

Description
       This module is the only module which uses Perl's	DBI.  It manages all
       database	interaction.

General	Functions
   new
       is the constructor. All parameters are identical	with the ones of
       OpenXPKI::Server::DBI::Driver because OpenXPKI::Server::DBI::DBH
       instanciates the	driver for the specific	database. Please check the
       driver documentation (OpenXPKI::Server::DBI::Driver) for	more
       informations.

       You should add SERVER_ID	and SERVER_SHIFT to the	configuration.

DBI related Functions
   connect
       has no parameters and starts a new database connection.

   disconnect
       has no parameters and disconnects from the database.

   do_query
       executes	a query	with the specified parameters. The query is defined in
       QUERY and the parameters	must be	as an array reference in the parameter
       BIND_VALUES. Please note	that the value of QUERY	is cached by the
       relating	DBD driver. So please never put	any dynamical parameters into
       the query.

   get_next_sth
       returns the ID of the next statement handle. This cam be	used to	finish
       a statement handle explicitly via finish_sth.

   get_sth
       get the last statement handle or	the specified statement	handle.

   finish_sth
       finish the last statement or the	specified statement. This is majorly a
       memory cleanup.

   rollback
       rollbacks an open transaction. No parameters.

   commit
       commits an open transaction. No parameters.

   get_new_serial
       is directly mapped to OpenXPKI::Server::DBI::Driver->get_new_serial The
       serial is processed after it is returned	from the driver	via the
       configuration parameters	SERVER_ID and SERVER_SHIFT.

   sequence_exists
       is directly mapped to OpenXPKI::Server::DBI::Driver->sequence_exists

   create_sequence
       is directly mapped to OpenXPKI::Server::DBI::Driver->create_sequence

   drop_sequence
       is directly mapped to OpenXPKI::Server::DBI::Driver->drop_sequence

   Driver dependend schema infos
       get_column_type

       is directly mapped to OpenXPKI::Server::DBI::Driver->get_column_type

       get_abstract_column_type

       is directly mapped to
       OpenXPKI::Server::DBI::Driver->get_abstract_column_type

       column_is_numeric

       is directly mapped to OpenXPKI::Server::DBI::Driver->column_is_numeric

       column_is_string

       is directly mapped to OpenXPKI::Server::DBI::Driver->column_is_string

       get_table_option

       is directly mapped to OpenXPKI::Server::DBI::Driver->get_table_option

Desctructor DESTROY
       rollbacks and finishs all open statement	handles. Finally it
       disconnects from	the database if	a connection is	still open.

See also
       DBI, OpenXPKI::Server::DBI::Driver and OpenXPKI::Server::DBI::Schema

perl v5.24.1			  2017-07-03	 OpenXPKI::Server::DBI::DBH(3)

Name | Description | General Functions | DBI related Functions | Desctructor DESTROY | See also

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=OpenXPKI::Server::DBI::DBH&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help