You've already forked pgbackrest
mirror of
https://github.com/pgbackrest/pgbackrest.git
synced 2025-07-03 00:26:59 +02:00
d30ec9c9ae
Inline functions are more efficient and if they are not used are automatically omitted from the binary. This also makes the implementation of these functions easier to find and removes the need for a declaration. That is, the complete implementation is located in the header rather than being spread between the header and C file.
66 lines
3.2 KiB
C
66 lines
3.2 KiB
C
/***********************************************************************************************************************************
|
|
PostgreSQL Client
|
|
|
|
Connect to a PostgreSQL database and run queries. This is not intended to be a general purpose client but is suitable for
|
|
pgBackRest's limited needs. In particular, data type support is limited to text, int, and bool types so it may be necessary to add
|
|
casts to queries to output one of these types.
|
|
***********************************************************************************************************************************/
|
|
#ifndef POSTGRES_QUERY_H
|
|
#define POSTGRES_QUERY_H
|
|
|
|
#include "common/type/object.h"
|
|
#include "common/type/string.h"
|
|
#include "common/type/variantList.h"
|
|
#include "common/time.h"
|
|
|
|
/***********************************************************************************************************************************
|
|
Object type
|
|
***********************************************************************************************************************************/
|
|
typedef struct PgClient PgClient;
|
|
|
|
/***********************************************************************************************************************************
|
|
Constructors
|
|
***********************************************************************************************************************************/
|
|
PgClient *pgClientNew(
|
|
const String *host, const unsigned int port, const String *database, const String *user, const TimeMSec queryTimeout);
|
|
|
|
/***********************************************************************************************************************************
|
|
Functions
|
|
***********************************************************************************************************************************/
|
|
// Open connection to PostgreSQL
|
|
PgClient *pgClientOpen(PgClient *this);
|
|
|
|
// Move to a new parent mem context
|
|
__attribute__((always_inline)) static inline PgClient *
|
|
pgClientMove(PgClient *this, MemContext *parentNew)
|
|
{
|
|
return objMove(this, parentNew);
|
|
}
|
|
|
|
// Execute a query and return results
|
|
VariantList *pgClientQuery(PgClient *this, const String *query);
|
|
|
|
// Close connection to PostgreSQL
|
|
void pgClientClose(PgClient *this);
|
|
|
|
/***********************************************************************************************************************************
|
|
Destructor
|
|
***********************************************************************************************************************************/
|
|
__attribute__((always_inline)) static inline void
|
|
pgClientFree(PgClient *this)
|
|
{
|
|
objFree(this);
|
|
}
|
|
|
|
/***********************************************************************************************************************************
|
|
Macros for function logging
|
|
***********************************************************************************************************************************/
|
|
String *pgClientToLog(const PgClient *this);
|
|
|
|
#define FUNCTION_LOG_PG_CLIENT_TYPE \
|
|
PgClient *
|
|
#define FUNCTION_LOG_PG_CLIENT_FORMAT(value, buffer, bufferSize) \
|
|
FUNCTION_LOG_STRING_OBJECT_FORMAT(value, pgClientToLog, buffer, bufferSize)
|
|
|
|
#endif
|