#include <ReadStreamSQLite.h>

Inheritance diagram for souffle::ReadStreamSQLite:

Collaboration diagram for souffle::ReadStreamSQLite:

Public Member Functions
	ReadStreamSQLite (const std::map< std::string, std::string > &rwOperation, SymbolTable &symbolTable, RecordTable &recordTable)

	~ReadStreamSQLite () override

Public Member Functions inherited from souffle::ReadStream
template<typename T >
void	readAll (T &relation)

Public Member Functions inherited from souffle::SerialisationStream< false >
virtual	~SerialisationStream ()=default

Protected Member Functions
void	checkTableExists ()

void	executeSQL (const std::string &sql)

void	openDB ()

void	prepareSelectStatement ()

Own< RamDomain[]>	readNextTuple () override
	Read and return the next tuple. More...

void	throwError (const std::string &message)

Protected Member Functions inherited from souffle::ReadStream
void	consumeChar (const std::string &str, char c, size_t &pos)
	Read past given character, consuming any preceding whitespace. More...

void	consumeWhiteSpace (const std::string &str, size_t &pos)
	Advance position in the string until first non-whitespace character. More...

RamDomain	readADT (const std::string &source, const std::string &adtName, size_t pos=0, size_t *charactersRead=nullptr)

std::string	readAlphanumeric (const std::string &source, size_t &pos)
	Read the next alphanumeric sequence (corresponding to IDENT). More...

RamDomain	readRecord (const std::string &source, const std::string &recordTypeName, size_t pos=0, size_t *charactersRead=nullptr)
	Read a record from a string. More...

	ReadStream (const std::map< std::string, std::string > &rwOperation, SymbolTable &symTab, RecordTable &recTab)

std::string	readUntil (const std::string &source, const std::string stopChars, const size_t pos, size_t *charactersRead)

Protected Member Functions inherited from souffle::SerialisationStream< false >
	SerialisationStream (RO< SymbolTable > &symTab, RO< RecordTable > &recTab, const std::map< std::string, std::string > &rwOperation)

	SerialisationStream (RO< SymbolTable > &symTab, RO< RecordTable > &recTab, Json types)

	SerialisationStream (RO< SymbolTable > &symTab, RO< RecordTable > &recTab, Json types, std::vector< std::string > relTypes, size_t auxArity=0)

Static Protected Member Functions
static std::string	getFileName (const std::map< std::string, std::string > &rwOperation)
	Return given filename or construct from relation name. More...

Protected Attributes
sqlite3 *	db = nullptr

const std::string	dbFilename

const std::string	relationName

sqlite3_stmt *	selectStatement = nullptr

Protected Attributes inherited from souffle::SerialisationStream< false >
size_t	arity

size_t	auxiliaryArity

RO< RecordTable > &	recordTable

RO< SymbolTable > &	symbolTable

std::vector< std::string >	typeAttributes

Json	types

Additional Inherited Members
Protected Types inherited from souffle::SerialisationStream< false >
using	RO = std::conditional_t< readOnlyTables, const A, A >

Detailed Description

Definition at line 39 of file ReadStreamSQLite.h.

Constructor & Destructor Documentation

◆ ReadStreamSQLite()

souffle::ReadStreamSQLite::ReadStreamSQLite	(	const std::map< std::string, std::string > &	rwOperation,
		SymbolTable &	symbolTable,
		RecordTable &	recordTable
	)

inline

Definition at line 41 of file ReadStreamSQLite.h.

                                  {
         sqlite3_finalize(selectStatement);
         sqlite3_close(db);

◆ ~ReadStreamSQLite()

souffle::ReadStreamSQLite::~ReadStreamSQLite ( )

inlineoverride

Definition at line 50 of file ReadStreamSQLite.h.

          :
     /**
      * Read and return the next tuple.

References selectStatement.

Member Function Documentation

◆ checkTableExists()

void souffle::ReadStreamSQLite::checkTableExists ( )

inlineprotected

Definition at line 137 of file ReadStreamSQLite.h.

                                                                                                       {
             throwError("SQLite error in sqlite3_prepare_v2: ");
         }
  
         if (sqlite3_step(tableStatement) == SQLITE_ROW) {
             int count = sqlite3_column_int(tableStatement, 0);
             if (count > 0) {
                 sqlite3_finalize(tableStatement);
                 return;
             }
         }
         sqlite3_finalize(tableStatement);
         throw std::invalid_argument(
                 "Required table or view does not exist in " + dbFilename + " for relation " + relationName);
     }
  
     /**
      * Return given filename or construct from relation name.
      * Default name is [configured path]/[relation name].sqlite

References throwError().

Here is the call graph for this function:

◆ executeSQL()

void souffle::ReadStreamSQLite::executeSQL ( const std::string & sql )

inlineprotected

Definition at line 97 of file ReadStreamSQLite.h.

                              {
             std::stringstream error;
             error << "SQLite error in sqlite3_exec: " << sqlite3_errmsg(db) << "\n";
             error << "SQL error: " << errorMessage << "\n";
             error << "SQL: " << sql << "\n";
             sqlite3_free(errorMessage);
             throw std::invalid_argument(error.str());
         }
     }
  
     void throwError(const std::string& message) {
         std::stringstream error;
         error << message << sqlite3_errmsg(db) << "\n";

◆ getFileName()

static std::string souffle::ReadStreamSQLite::getFileName ( const std::map< std::string, std::string > & rwOperation )

inlinestaticprotected

Return given filename or construct from relation name.

Default name is [configured path]/[relation name].sqlite

Parameters

rwOperation map of IO configuration options

Returns: input filename

Definition at line 167 of file ReadStreamSQLite.h.

                                  {
             name = getOr(rwOperation, "fact-dir", ".") + "/" + name;
         }
         return name;
     }
  
     const std::string dbFilename;
     const std::string relationName;
     sqlite3_stmt* selectStatement = nullptr;

◆ openDB()

void souffle::ReadStreamSQLite::openDB ( )

inlineprotected

Definition at line 128 of file ReadStreamSQLite.h.

                             {
         sqlite3_stmt* tableStatement;
         std::stringstream selectSQL;

◆ prepareSelectStatement()

void souffle::ReadStreamSQLite::prepareSelectStatement ( )

inlineprotected

Definition at line 119 of file ReadStreamSQLite.h.

                                                                                                        {
             throwError("SQLite error in sqlite3_prepare_v2: ");
         }
     }
  
     void openDB() {
         if (sqlite3_open(dbFilename.c_str(), &db) != SQLITE_OK) {
             throwError("SQLite error in sqlite3_open: ");

References throwError().

Here is the call graph for this function:

◆ readNextTuple()

Own<RamDomain[]> souffle::ReadStreamSQLite::readNextTuple ( )

inlineoverrideprotectedvirtual

Read and return the next tuple.

Returns nullptr if no tuple was readable.

Returns

Implements souffle::ReadStream.

Definition at line 62 of file ReadStreamSQLite.h.

                                                    {
             std::string element(reinterpret_cast<const char*>(sqlite3_column_text(selectStatement, column)));
  
             if (element.empty()) {
                 element = "n/a";
             }
  
             try {
                 auto&& ty = typeAttributes.at(column);
                 switch (ty[0]) {
                     case 's': tuple[column] = symbolTable.unsafeLookup(element); break;
                     case 'i':
                     case 'u':
                     case 'f':
                     case 'r': tuple[column] = RamSignedFromString(element); break;
                     default: fatal("invalid type attribute: `%c`", ty[0]);
                 }
             } catch (...) {
                 std::stringstream errorMessage;
                 errorMessage << "Error converting number in column " << (column) + 1;
                 throw std::invalid_argument(errorMessage.str());
             }
         }
  
         return tuple;
     }
  
     void executeSQL(const std::string& sql) {
         assert(db && "Database connection is closed");
  

◆ throwError()

void souffle::ReadStreamSQLite::throwError ( const std::string & message )

inlineprotected

Definition at line 113 of file ReadStreamSQLite.h.

                                   {
         std::stringstream selectSQL;
         selectSQL << "SELECT * FROM '" << relationName << "'";

Referenced by checkTableExists(), and prepareSelectStatement().

Field Documentation

◆ db

sqlite3* souffle::ReadStreamSQLite::db = nullptr

protected

Definition at line 182 of file ReadStreamSQLite.h.

◆ dbFilename

const std::string souffle::ReadStreamSQLite::dbFilename

protected

Definition at line 179 of file ReadStreamSQLite.h.

◆ relationName

const std::string souffle::ReadStreamSQLite::relationName

protected

Definition at line 180 of file ReadStreamSQLite.h.

◆ selectStatement

sqlite3_stmt* souffle::ReadStreamSQLite::selectStatement = nullptr

protected

Definition at line 181 of file ReadStreamSQLite.h.

Referenced by ~ReadStreamSQLite().

The documentation for this class was generated from the following file:

include/souffle/io/ReadStreamSQLite.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ReadStreamSQLite()

◆ ~ReadStreamSQLite()

Member Function Documentation

◆ checkTableExists()

◆ executeSQL()

◆ getFileName()

◆ openDB()

◆ prepareSelectStatement()

◆ readNextTuple()

◆ throwError()

Field Documentation

◆ db

◆ dbFilename

◆ relationName

◆ selectStatement