logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

PQregisterUserDefinedTypes - Registers a user-defined types.

Author

       A contribution of eSilo, LLC. for the PostgreSQL Database Management System.  Written by  Andrew  Chernow
       and Merlin Moncure.

Deprecated

       THIS  FUNCTION  IS  DEPRECATED.   New  applications  should  use PQregisterTypes.  This function is now a
       wrapper to PQregisterTypes.

Description

       The PQregisterUserDefinedTypes() function allows an application to  register  one  or  more  user-defined
       types at runtime.  User-defined types are custom types in a backend that implement their own C procedures
       for in/out/send/recv.

       This function must execute a query against the backend to retrieve type information for each user-defined
       type,  thus  this should not be called from within a transaction.  It is recommended to register multiple
       types at the same time to avoid round trip overhead.

       The types argument is an array containing count user-defined types to register.  If  any  type  does  not
       exist, the register is aborted.  Either typput and/or typget must be specified for each type in the types
       array.

       NOTE:  The  typname  member  of  the  PGregisterType  structure can optionally contain the type's schema:
       schema.typname.

       WARNING: PQparamCreate is only aware of types that have already been registered.  If you need  to  put  a
       type into a param, make sure it is first registered.

       User-definedTypesRegistration
       This example registers two user-defined types.

              PGregisterTypetypes[]={{"graphics.rgb",rgb_put,rgb_get},{"graphics.digon",digon_put,digon_get}};if(!PQregisterUserDefinedTypes(conn,types,2))fprintf(stderr,"PQregisterUserDefinedTypes:%s\n",PQgeterror());

Examples

       None.

Name

       PQregisterUserDefinedTypes - Registers a user-defined types.

Reporting Bugs

       Report bugs to <libpqtypes@esilo.com>.

Return Value

       On  success,  a non-zero value is returned.  On error, zero is returned and PQgeterror(3) will contain an
       error message.

See Also

pqt-handlers(3), PQputf(3), PQgetf(3)

libpqtypes                                            2011                         PQregisterUserDefinedTypes(3)

Synopsis

#include<libpqtypes.h>intPQregisterUserDefinedTypes(PGconn*conn,PGregisterType*types,intcount);

See Also