sqlite_tool.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
/*
 * sqlite_tool.h
 *
 *  Created on: 26 Jun 2015
 *      Author: billy
 */
 
#ifndef SQLITE_TOOL_H_
#define SQLITE_TOOL_H_
 
#include "typedefs.h"
#include "jansson.h"
#include "sqlite_library.h"
#include "sqlite3.h"
#include "linked_list.h"
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
#ifdef ALLOCATE_SQLITE_TAGS
  #define SQLITE_PREFIX GRASSROOTS_SQLITE_API
  #define SQLITE_VAL(x) = x
#else
  #define SQLITE_PREFIX extern GRASSROOTS_SQLITE_API
  #define SQLITE_VAL(x)
#endif
 
#endif    /* #ifndef DOXYGEN_SHOULD_SKIP_THIS */
 
 
 
SQLITE_PREFIX const char *SQLITE_OP_EQUALS_S SQLITE_VAL("=");
 
SQLITE_PREFIX const char *SQLITE_SET_CLAUSE_S SQLITE_VAL("set");
 
SQLITE_PREFIX const char *SQLITE_WHERE_CLAUSE_S SQLITE_VAL("where");
 
 
typedef struct SQLiteTool
{
  sqlite3 *sqlt_database_p;
 
  char *sqlt_table_s;
} SQLiteTool;
 
 
 
#ifdef __cplusplus
extern "C"
{
#endif
 
 
GRASSROOTS_SQLITE_API bool SetSQLiteDatabase (SQLiteTool *tool_p, const char *db_s, int flags);
 
 
GRASSROOTS_SQLITE_API bool SetSQLiteToolTable (SQLiteTool *tool_p, const char *table_s);
 
 
 
GRASSROOTS_SQLITE_API SQLiteTool *AllocateSQLiteTool (const char *db_s, int flags);
 
 
GRASSROOTS_SQLITE_API bool CloseSQLiteTool (SQLiteTool *tool_p);
 
 
 
GRASSROOTS_SQLITE_API void FreeSQLiteTool (SQLiteTool *tool_p);
 
 
GRASSROOTS_SQLITE_API char *InsertOrUpdateSQLiteData (SQLiteTool *tool_p, json_t *values_p, const char * const table_s, const char * const primary_key_s);
 
 
GRASSROOTS_SQLITE_API bool RemoveSQLiteRows (SQLiteTool *tool_p, const json_t *selector_json_p, const bool remove_first_match_only_flag);
 
 
GRASSROOTS_SQLITE_API json_t *FindMatchingSQLiteDocuments (SQLiteTool *tool_p, LinkedList *where_clauses_p, const char **fields_ss, char **error_ss);
 
 
GRASSROOTS_SQLITE_API json_t *GetAllSQLiteResultsAsJSON (SQLiteTool *tool_p);
 
 
GRASSROOTS_SQLITE_API int32 GetAllSQLiteResultsForKeyValuePair (SQLiteTool *tool_p, json_t **docs_pp, const char * const key_s, const char * const value_s, const char **fields_ss);
 
 
GRASSROOTS_SQLITE_API json_t *GetCurrentValuesFromSQLiteToolAsJSON (SQLiteTool *tool_p, const char **fields_ss, const size_t num_fields);
 
 
GRASSROOTS_SQLITE_API json_t *GetAllExistingSQLiteResultsAsJSON (SQLiteTool *tool_p);
 
 
GRASSROOTS_SQLITE_API int32 IsKeyValuePairInDatabase (SQLiteTool *tool_p, const char *database_s, const char *key_s, const char *value_s);
 
 
GRASSROOTS_SQLITE_API char *InsertOrUpdateSQLiteData (SQLiteTool *tool_p, json_t *values_p, const char * const table_s, const char * const primary_key_s);
 
 
GRASSROOTS_SQLITE_API void FreeSQLiteToolErrorString (SQLiteTool *tool_p, char *error_s);
 
 
GRASSROOTS_SQLITE_API char *CreateSQLiteTable (SQLiteTool *tool_p, const char *table_s, LinkedList *columns_p, const bool delete_if_exists_flag);
 
 
GRASSROOTS_SQLITE_API char *RunSQLiteToolStatement (SQLiteTool *tool_p, const char *sql_s, int (*callback_fn) (void *data_p, int num_columns, char **columns_aa_text_ss, char **column_names_ss), void *data_p);
 
GRASSROOTS_SQLITE_API char *EasyRunSQLiteToolStatement (SQLiteTool *tool_p, const char *sql_s);
 
 
GRASSROOTS_SQLITE_API bool InsertSQLiteRow (SQLiteTool *tool_p, const json_t *data_p, char **error_ss);
 
 
GRASSROOTS_SQLITE_API bool PrepareStatement (SQLiteTool *tool_p, sqlite3_stmt **statement_pp, const char *sql_s);
 
 
#ifdef __cplusplus
}
#endif
 
 
 
#endif /* _TOOL_H_ */