vapi/libpq.vapi

   1 /* libpq.vapi
   2  *
   3  * Copyright (C) 2009 Jukka-Pekka Iivonen
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  18  *
  19  * Author:
  20  *      Jukka-Pekka Iivonen <jp0409@jippii.fi>
  21  */
  22
  23 #if LIBPQ_9_3
  24 [CCode (cprefix = "PQ", cheader_filename = "libpq-fe.h")]
  25 #else
  26 [CCode (cprefix = "PQ", cheader_filename = "postgresql/libpq-fe.h")]
  27 #endif
  28 namespace Postgres {
  29
  30         [CCode (cname = "ConnStatusType", cprefix = "CONNECTION_", has_type_id = false)]
  31         public enum ConnectionStatus {
  32                 OK,
  33                 BAD,
  34                 STARTED,
  35                 MADE,
  36                 AWAITING_RESPONSE,
  37                 AUTH_OK,
  38                 SETENV,
  39                 SSL_STARTUP,
  40                 NEEDED
  41         }
  42
  43         [CCode (cname = "PostgresPollingStatusType", cprefix = "PGRES_POLLING_", has_type_id = false)]
  44         public enum PollingStatus {
  45                 FAILED,
  46                 READING,
  47                 WRITING,
  48                 OK,
  49                 ACTIVE
  50         }
  51
  52         [CCode (cname = "ExecStatusType", cprefix = "PGRES_", has_type_id = false)]
  53         public enum ExecStatus {
  54                 EMPTY_QUERY,
  55                 COMMAND_OK,
  56                 TUPLES_OK,
  57                 COPY_OUT,
  58                 COPY_IN,
  59                 BAD_RESPONSE,
  60                 NONFATAL_ERROR,
  61                 FATAL_ERROR
  62         }
  63
  64         [CCode (cname = "PGTransactionStatusType", cprefix = "PQTRANS_", has_type_id = false)]
  65         public enum TransactionStatus {
  66                 IDLE,
  67                 ACTIVE,
  68                 INTRANS,
  69                 INERROR,
  70                 UNKNOWN
  71         }
  72
  73         [CCode (cname = "PGVerbosity", cprefix = "PQERRORS_", has_type_id = false)]
  74         public enum Verbosity {
  75                 TERSE,
  76                 DEFAULT,
  77                 VERBOSE
  78         }
  79
  80         [CCode (cname = "int", cprefix = "PG_DIAG_", has_type_id = false)]
  81         public enum FieldCode {
  82                 SEVERITY,
  83                 SQLSTATE,
  84                 MESSAGE_PRIMARY,
  85                 MESSAGE_DETAIL,
  86                 MESSAGE_HINT,
  87                 STATEMENT_POSITION,
  88                 INTERNAL_POSITION,
  89                 INTERNAL_QUERY,
  90                 CONTEXT,
  91                 SOURCE_FILE,
  92                 SOURCE_LINE,
  93                 SOURCE_FUNCTION
  94         }
  95
  96         [CCode (cname = "PGPing", cprefix = "PQPING_", has_type_id = false)]
  97         public enum Ping {
  98                 OK,
  99                 REJECT,
 100                 NO_RESPONCE,
 101                 NO_ATTEMPT
 102         }
 103
 104         [Compact]
 105         [CCode (cname = "PGnotify", free_function = "PQfreemem")]
 106         public class Notify {
 107                 public string relname;
 108                 public int    be_pid;
 109                 public string extra;
 110
 111                 private Notify ();
 112         }
 113
 114         [CCode (cname = "PQnoticeReceiver")]
 115         public delegate void NoticeReceiverFunc (void* arg, Result res);
 116
 117         [CCode (cname = "PQnoticeProcessor")]
 118         public delegate void NoticeProcessorFunc (void* arg, string message);
 119
 120         [CCode (cname = "PQprintOpt", has_type_id = false)]
 121         public struct PrintOpt {
 122                 public bool     header;
 123                 public bool     align;
 124                 public bool     standard;
 125                 public bool     html3;
 126                 public bool     expanded;
 127                 public bool     pager;
 128                 public string   fieldSep;
 129                 public string   tableOpt;
 130                 public string   caption;
 131                 public string[] fieldName;
 132         }
 133
 134         [Compact]
 135         [CCode (cname = "PQconninfoOption", free_function = "PQconninfoFree")]
 136         public class ConnectionOptions {
 137                 public string keyword;
 138                 public string envvar;
 139                 public string compiled;
 140                 public string val;
 141                 public string label;
 142                 public string dispchar;
 143                 public int    dispsize;
 144         }
 145
 146         [CCode (cname = "PQArgBlock", has_type_id = false)]
 147         public struct ArgBlock {
 148                 public int len;
 149                 public int isint;
 150         }
 151
 152         [SimpleType]
 153         [CCode (cname = "uint", default_value = "0U", type_signature = "u", has_type_id = false)]
 154         public struct Oid {
 155         }
 156
 157         [CCode (cname = "InvalidOid")]
 158         public const uint InvalidOid;
 159
 160         [CCode (cname = "PQconnectStart")]
 161         public Database connect_start (string conninfo);
 162
 163         [CCode (cname = "PQconnectdb")]
 164         public Database connect_db (string conninfo);
 165
 166         [CCode (cname = "PQsetdbLogin")]
 167         public Database set_db_login (string host, string port, string options, string gtty, string db_name, string login, string pwd);
 168
 169         [CCode (cname = "PQsetdb")]
 170         public Database set_db (string host, string port, string options, string gtty, string db_name);
 171
 172         [CCode (cname = "PQconndefaults")]
 173         public ConnectionOptions get_default_options ();
 174
 175         [CCode (cname = "PQinitSSL")]
 176         public void init_ssl (int do_init);
 177
 178         [CCode (cname = "PQisthreadsafe")]
 179         public int is_thread_safe ();
 180
 181         [CCode (cname = "PQresStatus")]
 182         public unowned string result_status (ExecStatus status);
 183
 184         [Compact]
 185         [CCode (free_function = "PQfreeCancel", cname = "PGcancel", cprefix = "PQ")]
 186         public class Cancel {
 187                 [CCode (cname = "PQcancel")]
 188                 public bool cancel (char[] errbuf, int errbufsize);
 189         }
 190
 191         /* Database Connection Handle */
 192         [Compact]
 193         [CCode (free_function = "PQfinish", cname = "PGconn", cprefix = "PQ")]
 194         public class Database {
 195                 [CCode (cname = "PQconnectPoll")]
 196                 public PollingStatus connect_poll ();
 197
 198                 [CCode (cname = "PQresetStart")]
 199                 public int reset_start ();
 200
 201                 [CCode (cname = "PQresetPoll")]
 202                 public PollingStatus reset_poll ();
 203
 204                 [CCode (cname = "PQreset")]
 205                 public void reset ();
 206
 207                 [CCode (cname = "PQgetCancel")]
 208                 public Cancel get_cancel ();
 209
 210                 [CCode (cname = "PQrequestCancel")]
 211                 public int request_cancel ();
 212
 213                 [CCode (cname = "PQdb")]
 214                 public unowned string get_db ();
 215
 216                 [CCode (cname = "PQuser")]
 217                 public unowned string get_user ();
 218
 219                 [CCode (cname = "PQpass")]
 220                 public unowned string get_passwd ();
 221
 222                 [CCode (cname = "PQhost")]
 223                 public unowned string get_host ();
 224
 225                 [CCode (cname = "PQport")]
 226                 public unowned string get_port ();
 227
 228                 [CCode (cname = "PQtty")]
 229                 public unowned string get_tty ();
 230
 231                 [CCode (cname = "PQoptions")]
 232                 public unowned string get_options ();
 233
 234                 [CCode (cname = "PQstatus")]
 235                 public ConnectionStatus get_status ();
 236
 237                 [CCode (cname = "PQtransactionStatus")]
 238                 public TransactionStatus get_transaction_status ();
 239
 240                 [CCode (cname = "PQparameterStatus")]
 241                 public unowned string get_parameter_status (string param_name);
 242
 243                 [CCode (cname = "PQprotocolVersion")]
 244                 public int get_protocol_Version ();
 245
 246                 [CCode (cname = "PQserverVersion")]
 247                 public int get_server_version ();
 248
 249                 [CCode (cname = "PQerrorMessage")]
 250                 public unowned string get_error_message ();
 251
 252                 [CCode (cname = "PQsocket")]
 253                 public int get_socket ();
 254
 255                 [CCode (cname = "PQbackendPID")]
 256                 public int get_backend_pid ();
 257
 258                 [CCode (cname = "PQconnectionNeedsPassword")]
 259                 public int connection_needs_password ();
 260
 261                 [CCode (cname = "PQconnectionUsedPassword")]
 262                 public int connection_used_password ();
 263
 264                 [CCode (cname = "PQclientEncoding")]
 265                 public int get_client_encoding ();
 266
 267                 [CCode (cname = "PQsetClientEncoding")]
 268                 public int set_client_encoding (string encoding);
 269
 270                 [CCode (cname = "PQgetssl")]
 271                 public void* get_ssl ();
 272
 273                 [CCode (cname = "PQsetErrorVerbosity")]
 274                 public Verbosity set_error_verbosity (Verbosity verbosity);
 275
 276                 [CCode (cname = "PQtrace")]
 277                 public void trace (GLib.FileStream debug_port);
 278
 279                 [CCode (cname = "PQuntrace")]
 280                 public void untrace ();
 281
 282                 [CCode (cname = "PQsetNoticeReceiver")]
 283                 public NoticeReceiverFunc set_notice_receiver (NoticeReceiverFunc proc_func, void* arg);
 284
 285                 [CCode (cname = "PQsetNoticeProcessor")]
 286                 public NoticeProcessorFunc set_notice_processor (NoticeProcessorFunc proc_func, void* arg);
 287
 288                 [CCode (cname = "PQexec")]
 289                 public Result exec (string query);
 290
 291                 [CCode (cname = "PQexecParams")]
 292                 public Result exec_params (string command, int n_params, [CCode (array_length = false)] Oid[]? param_types, [CCode (array_length = false)] string[]? param_values, [CCode (array_length = false)] int[]? param_lengths, [CCode (array_length = false)] int[]? param_formats, int result_format);
 293
 294                 [CCode (cname = "PQprepare")]
 295                 public Result prepare (string stmt_name, string query, [CCode (array_length_pos = 2.9)] Oid[]? param_types);
 296
 297                 [CCode (cname = "PQexecPrepared")]
 298                 public Result exec_prepared (string stmt_name, int n_params, [CCode (array_length = false)] string[]? param_values, [CCode (array_length = false)] int[]? param_lengths, [CCode (array_length = false)] int[]? param_formats, int result_format);
 299
 300                 [CCode (cname = "PQsendQuery")]
 301                 public int send_query (string query);
 302
 303                 [CCode (cname = "PQsendQueryParams")]
 304                 public int send_query_params (string command, int n_params, [CCode (array_length = false)] Oid[]? param_types, [CCode (array_length = false)] string[]? param_values, [CCode (array_length = false)] int[]? param_lengths, [CCode (array_length = false)] int[]? param_formats, int result_format);
 305
 306                 [CCode (cname = "PQsendPrepare")]
 307                 public int send_prepare (string stmt_name, string query, [CCode (array_length_pos = 2.9)] Oid[]? param_types);
 308
 309                 [CCode (cname = "PQsendQueryPrepared")]
 310                 public int send_query_prepared (string stmt_name, int n_params, [CCode (array_length = false)] string[]? param_values, [CCode (array_length = false)] int[]? param_lengths, [CCode (array_length = false)] int[]? param_formats, int resultFormat);
 311
 312                 [CCode (cname = "PQgetResult")]
 313                 public Result get_result ();
 314
 315                 [CCode (cname = "PQisBusy")]
 316                 public int is_busy ();
 317
 318                 [CCode (cname = "PQconsumeInput")]
 319                 public int consume_input ();
 320
 321                 [CCode (cname = "PQnotifies")]
 322                 public Notify get_notifies ();
 323
 324                 [CCode (cname = "PQputCopyData")]
 325                 public int put_copy_data (string buffer, int nbytes);
 326
 327                 [CCode (cname = "PQputCopyEnd")]
 328                 public int put_copy_end (string error_msg);
 329
 330                 [CCode (cname = "PQgetCopyData")]
 331                 public int get_copy_data (string[] buffer, int async);
 332
 333                 [CCode (cname = "PQsetnonblocking")]
 334                 public int set_non_blocking (int arg);
 335
 336                 [CCode (cname = "PQisnonblocking")]
 337                 public int is_non_blocking ();
 338
 339                 [CCode (cname = "PQping")]
 340                 public Ping ping();
 341
 342                 [CCode (cname = "PQpingParams")]
 343                 public Ping ping_params(string keywords, string values, int expand_dbname);
 344
 345                 [CCode (cname = "PQflush")]
 346                 public int flush ();
 347
 348                 [CCode (cname = "PQfn")]
 349                 public Result fn (int fnid, int[] result_buf, out int result_len, int result_is_int, ArgBlock args, int nargs);
 350
 351                 [CCode (cname = "PQdescribePrepared")]
 352                 public Result describe_prepared (string stmt);
 353
 354                 [CCode (cname = "PQdescribePortal")]
 355                 public Result describe_portal (string portal);
 356
 357                 [CCode (cname = "PQsendDescribePrepared")]
 358                 public int send_describe_prepared (string stmt);
 359
 360                 [CCode (cname = "PQsendDescribePortal")]
 361                 public int send_describe_portal (string portal);
 362
 363                 [CCode (cname = "PQmakeEmptyPGresult")]
 364                 public Result make_empty_result (ExecStatus status);
 365
 366                 [CCode (cname = "PQescapeStringConn")]
 367                 public size_t escape_string_conn (string to, string from, size_t length, out int error);
 368
 369                 [CCode (cname = "PQescapeByteaConn")]
 370                 public uchar[] escape_bytea_conn (string from, size_t from_length, out size_t to_length);
 371
 372                 [CCode (cname = "lo_open")]
 373                 public int lo_open (int lobj_id, int mode);
 374
 375                 [CCode (cname = "lo_close")]
 376                 public int lo_close (int fd);
 377
 378                 [CCode (cname = "lo_read")]
 379                 public int lo_read (int fd, string buf, size_t len);
 380
 381                 [CCode (cname = "lo_write")]
 382                 public int lo_write (int fd, string buf, size_t len);
 383
 384                 [CCode (cname = "lo_lseek")]
 385                 public int lo_lseek (int fd, int offset, int whence);
 386
 387                 [CCode (cname = "lo_creat")]
 388                 public int lo_creat (int mode);
 389
 390                 [CCode (cname = "lo_create")]
 391                 public int lo_create (int lobj_id);
 392
 393                 [CCode (cname = "lo_tell")]
 394                 public int lo_tell (int fd);
 395
 396                 [CCode (cname = "lo_truncate")]
 397                 public int lo_truncate (int fd, size_t len);
 398
 399                 [CCode (cname = "lo_unlink")]
 400                 public int lo_unlink (int lobj_id);
 401
 402                 [CCode (cname = "lo_import")]
 403                 public int lo_import (string filename);
 404
 405                 [CCode (cname = "lo_export")]
 406                 public int lo_export (int lobj_id, string filename);
 407         }
 408
 409         [CCode (cname = "pgthreadlock_t")]
 410         public delegate void ThreadLockFunc (int acquire);
 411
 412         [CCode (cname = "PQregisterThreadLock")]
 413         public ThreadLockFunc register_thread_lock (ThreadLockFunc newhandler);
 414
 415         [CCode (cname = "PQunescapeBytea")]
 416         public uchar[] unescape_bytea (uchar[] strtext, out size_t retbuflen);
 417
 418         [Compact]
 419         [CCode (free_function = "PQclear", cname = "PGresult", cprefix = "PQ")]
 420         public class Result {
 421                 [CCode (cname = "PQresultStatus")]
 422                 public ExecStatus get_status ();
 423
 424                 [CCode (cname = "PQresultErrorMessage")]
 425                 public unowned string get_error_message ();
 426
 427                 [CCode (cname = "PQresultErrorField")]
 428                 public unowned string get_error_field (FieldCode field_code);
 429
 430                 [CCode (cname = "PQntuples")]
 431                 public int get_n_tuples ();
 432
 433                 [CCode (cname = "PQnfields")]
 434                 public int get_n_fields ();
 435
 436                 [CCode (cname = "PQbinaryTuples")]
 437                 public bool is_binary_tuples ();
 438
 439                 [CCode (cname = "PQfname")]
 440                 public unowned string get_field_name (int field_num);
 441
 442                 [CCode (cname = "PQfnumber")]
 443                 public int get_field_number (string field_name);
 444
 445                 [CCode (cname = "PQftable")]
 446                 public Oid get_field_table (int field_num);
 447
 448                 [CCode (cname = "PQftablecol")]
 449                 public int get_field_table_col (int field_num);
 450
 451                 [CCode (cname = "PQfformat")]
 452                 public int get_field_format (int field_num);
 453
 454                 [CCode (cname = "PQftype")]
 455                 public Oid get_field_type (int field_num);
 456
 457                 [CCode (cname = "PQfsize")]
 458                 public int get_fsize (int field_num);
 459
 460                 [CCode (cname = "PQfmod")]
 461                 public int get_field_mod (int field_num);
 462
 463                 [CCode (cname = "PQcmdStatus")]
 464                 public unowned string get_cmd_status ();
 465
 466                 [CCode (cname = "PQoidValue")]
 467                 public Oid get_oid_value ();
 468
 469                 [CCode (cname = "PQcmdTuples")]
 470                 public unowned string get_cmd_tuples ();
 471
 472                 [CCode (cname = "PQgetvalue")]
 473                 public unowned string get_value (int tup_num, int field_num);
 474
 475                 [CCode (cname = "PQgetlength")]
 476                 public int get_length (int tup_num, int field_num);
 477
 478                 [CCode (cname = "PQgetisnull")]
 479                 public bool is_null (int tup_num, int field_num);
 480
 481                 [CCode (cname = "PQnparams")]
 482                 public int get_n_params ();
 483
 484                 [CCode (cname = "PQparamtype")]
 485                 public int get_param_type (int param_num);
 486         }
 487
 488         [CCode (cname = "PQfreemem")]
 489         public void free_mem (void* ptr);
 490
 491         [CCode (cname = "PQprint")]
 492         public void print (GLib.FileStream fout, Result res, PrintOpt ps);
 493
 494         [CCode (cname = "PQmblen")]
 495         public int mb_len (string s, int encoding);
 496
 497         [CCode (cname = "PQdsplen")]
 498         public int dsp_len (string s, int encoding);
 499
 500         [CCode (cname = "PQenv2encoding")]
 501         public int env2encoding ();
 502
 503         [CCode (cname = "PQencryptPassword")]
 504         public unowned string encrypt_password (string passwd, string user);
 505
 506         [CCode (cname = "pg_char_to_encoding")]
 507         public int char_to_encoding (string name);
 508
 509         [CCode (cname = "pg_encoding_to_char")]
 510         public unowned string encoding_to_char (int encoding);
 511
 512         [CCode (cname = "pg_valid_server_encoding_id")]
 513         public int valid_server_encoding_id (int encoding);
 514 }
 515