---

dbapi.h

Go to the documentation of this file.

/* GtkSQL -- an interactive graphical query tool for PostgreSQL and MySQL.
 * Copyright (C) 1998-2003  Lionel ULMER, Darryl Luff.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of tdo_he License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef _DBAPI_H
#define _DBAPI_H

#include "forms.h"

enum QueryStatus {
    DB_QUERY_ERROR = 0,
    DB_QUERY_EMPTY = 1,
    DB_QUERY_COMMAND_OK = 2,
    DB_QUERY_RECORDS_OK = 3,
    DB_QUERY_OTHER = 4
};

enum ConnectStatus {
    CONNECT_DISCONNECTED = 0,
    CONNECT_ERROR,
    CONNECT_OK
};

typedef struct _dbconnector DBConnector;

typedef struct _keyword {
    char *key;              
    int type;               
    struct _keyword *next;  
} Keyword;

typedef struct {
    char *name;     
    char *type;     
    char *length;   
} DBFieldDef;

typedef struct {
    char *name;             
    int field_num;          
    DBFieldDef *field_def;  
} DBTableDef;

struct db_conn {
    DBConnector *connector; 
    int connectionStatus;   
    /* Low-level SQL functions */
    /* Connection and status functions. */
    int (*DBdisconnect) (struct db_conn *); 
    /* Information functions. */
    char *(*DBget_error_message) (struct db_conn *);    
    char *(*DBget_db_name) (struct db_conn *);          
    /* Queries functions */
    void *(*DBexecute_query) (struct db_conn *, char *);    
    int (*DBget_query_status) (struct db_conn *, void *);   
    int (*DBget_record_number) (struct db_conn *, void *);  
    int (*DBget_field_number) (struct db_conn *, void *);   
    char *(*DBget_field_name) (struct db_conn *, void *, int field);    
    char *(*DBget_field_value) (struct db_conn *, void *, int record, int field);   
    void (*DBclear_result) (struct db_conn *, void *);  
    Keyword *keylist;   
    /* Tables functions (definitions, ...) */
    int (*DBget_table_def) (struct db_conn *);          
    void (*DBfree_table_def) (struct db_conn *);        
    int (*DBget_table_num) (struct db_conn *);          
    DBTableDef *(*DBget_table) (struct db_conn *, int); 
    /* Connection parameters    */
    char *server;   
    char *user;     
    char *pass;     
    void *pvt;  
    int pvtlen; 
};

typedef struct db_conn DBConnection;

struct _dbconnector {
    char *dbtype;   
    int (*db_connect_callback) (DBConnector *, DBConnection **);
    void (*url_to_form) (Form *, char *);   
    char *(*form_to_url) (Form *);  
    Form *db_frm;   
    void (*app_error_dialog) (char *, char *);
};

extern DBConnector **connectorTable;

typedef DBConnector *(*db_register_func) (void (*error_dialog) (char *, char *));

DBConnection *db_connect(DBConnector *dbc);

DBConnection *db_connect_url(char *url);

void db_disconnect(DBConnection *conn, void(*display_error) (char *, char *));

DBConnector *dbconnector_new(void);
#endif

---