#include <WriteStreamSQLite.h>

Inheritance diagram for souffle::WriteStreamSQLite:

Collaboration diagram for souffle::WriteStreamSQLite:

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

	~WriteStreamSQLite () override

Public Member Functions inherited from souffle::WriteStream
template<typename T >
void	writeAll (const T &relation)

template<>
void	writeNext (const RamDomain *tuple)

template<typename T >
void	writeSize (const T &relation)

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

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

Protected Member Functions
void	writeNextTuple (const RamDomain *tuple) override

void	writeNullary () override

Protected Member Functions inherited from souffle::WriteStream
void	outputADT (std::ostream &destination, const RamDomain value, const std::string &name)

void	outputRecord (std::ostream &destination, const RamDomain value, const std::string &name)

template<typename Tuple >
void	writeNext (const Tuple tuple)

virtual void	writeSize (std::size_t)

Protected Member Functions inherited from souffle::SerialisationStream< true >
	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)

Private Member Functions
void	createRelationTable ()

void	createRelationView ()

void	createSymbolTable ()

void	createTables ()

void	executeSQL (const std::string &sql, sqlite3 *db)

uint64_t	getSymbolTableID (int index)

uint64_t	getSymbolTableIDFromDB (int index)

void	openDB ()

void	prepareInsertStatement ()

void	prepareStatements ()

void	prepareSymbolInsertStatement ()

void	prepareSymbolSelectStatement ()

void	throwError (const std::string &message)

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

Private Attributes
sqlite3 *	db = nullptr

const std::string	dbFilename

std::unordered_map< uint64_t, uint64_t >	dbSymbolTable

sqlite3_stmt *	insertStatement = nullptr

const std::string	relationName

sqlite3_stmt *	symbolInsertStatement = nullptr

sqlite3_stmt *	symbolSelectStatement = nullptr

const std::string	symbolTableName = "__SymbolTable"

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

Protected Attributes inherited from souffle::WriteStream
const bool	summary

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

size_t	auxiliaryArity

RO< RecordTable > &	recordTable

RO< SymbolTable > &	symbolTable

std::vector< std::string >	typeAttributes

Json	types

Detailed Description

Definition at line 40 of file WriteStreamSQLite.h.

Constructor & Destructor Documentation

◆ WriteStreamSQLite()

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

inline

Definition at line 42 of file WriteStreamSQLite.h.

                                   {
         sqlite3_finalize(insertStatement);
         sqlite3_finalize(symbolInsertStatement);

◆ ~WriteStreamSQLite()

souffle::WriteStreamSQLite::~WriteStreamSQLite ( )

inlineoverride

Definition at line 52 of file WriteStreamSQLite.h.

          :
     void writeNullary() override {}
  

Member Function Documentation

◆ createRelationTable()

void souffle::WriteStreamSQLite::createRelationTable ( )

inlineprivate

Definition at line 200 of file WriteStreamSQLite.h.

                                                      {
                 createTableText << ",'" << std::to_string(i) << "' ";
                 createTableText << "INTEGER";
             }
         }
         createTableText << ");";
         executeSQL(createTableText.str(), db);
         executeSQL("DELETE FROM '_" + relationName + "';", db);
     }
  
     void createRelationView() {
         // Create view with symbol strings resolved
         std::stringstream createViewText;

References i.

◆ createRelationView()

void souffle::WriteStreamSQLite::createRelationView ( )

inlineprivate

Definition at line 215 of file WriteStreamSQLite.h.

                                                  {
             std::string columnName = std::to_string(i);
             if (i != 0) {
                 projectionClause << ",";
             }
             if (typeAttributes.at(i)[0] == 's') {
                 projectionClause << "'_symtab_" << columnName << "'.symbol AS '" << columnName << "'";
                 fromClause << ",'" << symbolTableName << "' AS '_symtab_" << columnName << "'";
                 if (!firstWhere) {
                     whereClause << " AND ";
                 } else {
                     firstWhere = false;
                 }
                 whereClause << "'_" << relationName << "'.'" << columnName << "' = "
                             << "'_symtab_" << columnName << "'.id";
             } else {
                 projectionClause << "'_" << relationName << "'.'" << columnName << "'";
             }
         }
         createViewText << "SELECT " << projectionClause.str() << " FROM " << fromClause.str();
         if (!firstWhere) {
             createViewText << " WHERE " << whereClause.str();
         }
         createViewText << ";";
         executeSQL(createViewText.str(), db);
     }
     void createSymbolTable() {
         std::stringstream createTableText;
         createTableText << "CREATE TABLE IF NOT EXISTS '" << symbolTableName << "' ";
         createTableText << "(id INTEGER PRIMARY KEY, symbol TEXT UNIQUE);";

References i, relationName, symbolTableName, and souffle::SerialisationStream< true >::typeAttributes.

◆ createSymbolTable()

void souffle::WriteStreamSQLite::createSymbolTable ( )

inlineprivate

Definition at line 250 of file WriteStreamSQLite.h.

◆ createTables()

void souffle::WriteStreamSQLite::createTables ( )

inlineprivate

Definition at line 194 of file WriteStreamSQLite.h.

                                {
         std::stringstream createTableText;
         createTableText << "CREATE TABLE IF NOT EXISTS '_" << relationName << "' (";

◆ executeSQL()

void souffle::WriteStreamSQLite::executeSQL	(	const std::string &	sql,
		sqlite3 *	db
	)

inlineprivate

Definition at line 87 of file WriteStreamSQLite.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::WriteStreamSQLite::getFileName ( const std::map< std::string, std::string > & rwOperation )

inlinestaticprivate

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 264 of file WriteStreamSQLite.h.

                                  {
             name = getOr(rwOperation, "output-dir", ".") + "/" + name;
         }
         return name;
     }
  
     const std::string dbFilename;
     const std::string relationName;
     const std::string symbolTableName = "__SymbolTable";

◆ getSymbolTableID()

uint64_t souffle::WriteStreamSQLite::getSymbolTableID ( int index )

inlineprivate

Definition at line 122 of file WriteStreamSQLite.h.

                                                     {
             throwError("SQLite error in sqlite3_bind_text: ");
         }
         // Either the insert succeeds and we have a new row id or it already exists and a select is needed.
         uint64_t rowid;
         if (sqlite3_step(symbolInsertStatement) != SQLITE_DONE) {
             // The symbol already exists so select it.
             rowid = getSymbolTableIDFromDB(index);
         } else {
             rowid = sqlite3_last_insert_rowid(db);
         }
         sqlite3_clear_bindings(symbolInsertStatement);
         sqlite3_reset(symbolInsertStatement);
  
         dbSymbolTable[index] = rowid;
         return rowid;
     }
  
     void openDB() {
         if (sqlite3_open(dbFilename.c_str(), &db) != SQLITE_OK) {
             throwError("SQLite error in sqlite3_open");

References throwError().

Referenced by writeNextTuple().

Here is the call graph for this function:

◆ getSymbolTableIDFromDB()

uint64_t souffle::WriteStreamSQLite::getSymbolTableIDFromDB ( int index )

inlineprivate

Definition at line 109 of file WriteStreamSQLite.h.

                                                                {
             throwError("SQLite error in sqlite3_step: ");
         }
         uint64_t rowid = sqlite3_column_int64(symbolSelectStatement, 0);
         sqlite3_clear_bindings(symbolSelectStatement);
         sqlite3_reset(symbolSelectStatement);
         return rowid;
     }
     uint64_t getSymbolTableID(int index) {
         if (dbSymbolTable.count(index) != 0) {
             return dbSymbolTable[index];
         }

◆ openDB()

void souffle::WriteStreamSQLite::openDB ( )

inlineprivate

Definition at line 146 of file WriteStreamSQLite.h.

                              {
         prepareInsertStatement();
         prepareSymbolInsertStatement();

◆ prepareInsertStatement()

void souffle::WriteStreamSQLite::prepareInsertStatement ( )

inlineprivate

Definition at line 180 of file WriteStreamSQLite.h.

                                                  {
             insertSQL << ",@V" << i;
         }
         insertSQL << ");";
         const char* tail = nullptr;
         if (sqlite3_prepare_v2(db, insertSQL.str().c_str(), -1, &insertStatement, &tail) != SQLITE_OK) {
             throwError("SQLite error in sqlite3_prepare_v2: ");
         }
     }
  
     void createTables() {
         createRelationTable();
         createRelationView();

References i.

◆ prepareStatements()

void souffle::WriteStreamSQLite::prepareStatements ( )

inlineprivate

Definition at line 155 of file WriteStreamSQLite.h.

                                         {
         std::stringstream insertSQL;
         insertSQL << "INSERT INTO " << symbolTableName;
         insertSQL << " VALUES(null,@V0);";

◆ prepareSymbolInsertStatement()

void souffle::WriteStreamSQLite::prepareSymbolInsertStatement ( )

inlineprivate

Definition at line 160 of file WriteStreamSQLite.h.

                                                                                                              {
             throwError("SQLite error in sqlite3_prepare_v2: ");
         }
     }
  
     void prepareSymbolSelectStatement() {
         std::stringstream selectSQL;
         selectSQL << "SELECT id FROM " << symbolTableName;

References throwError().

Here is the call graph for this function:

◆ prepareSymbolSelectStatement()

void souffle::WriteStreamSQLite::prepareSymbolSelectStatement ( )

inlineprivate

Definition at line 170 of file WriteStreamSQLite.h.

                                                                                                              {
             throwError("SQLite error in sqlite3_prepare_v2: ");
         }
     }
  
     void prepareInsertStatement() {
         std::stringstream insertSQL;
         insertSQL << "INSERT INTO '_" << relationName << "' VALUES ";

References throwError().

Here is the call graph for this function:

◆ throwError()

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

inlineprivate

Definition at line 103 of file WriteStreamSQLite.h.

                                                {
         if (sqlite3_bind_text(symbolSelectStatement, 1, symbolTable.unsafeResolve(index).c_str(), -1,
                     SQLITE_TRANSIENT) != SQLITE_OK) {

Referenced by getSymbolTableID(), prepareSymbolInsertStatement(), and prepareSymbolSelectStatement().

◆ writeNextTuple()

void souffle::WriteStreamSQLite::writeNextTuple ( const RamDomain * tuple )

inlineoverrideprotectedvirtual

Implements souffle::WriteStream.

Definition at line 62 of file WriteStreamSQLite.h.

                                              {
                 case 's': value = getSymbolTableID(tuple[i]); break;
                 default: value = tuple[i]; break;
             }
  
 #if RAM_DOMAIN_SIZE == 64
             if (sqlite3_bind_int64(insertStatement, i + 1, value) != SQLITE_OK) {
 #else
             if (sqlite3_bind_int(insertStatement, i + 1, value) != SQLITE_OK) {
 #endif
                 throwError("SQLite error in sqlite3_bind_text: ");
             }
         }
         if (sqlite3_step(insertStatement) != SQLITE_DONE) {
             throwError("SQLite error in sqlite3_step: ");
         }
         sqlite3_clear_bindings(insertStatement);
         sqlite3_reset(insertStatement);
     }
  
 private:
     void executeSQL(const std::string& sql, sqlite3* db) {
         assert(db && "Database connection is closed");

References getSymbolTableID(), and i.

Here is the call graph for this function:

◆ writeNullary()

void souffle::WriteStreamSQLite::writeNullary ( )

inlineoverrideprotectedvirtual

Implements souffle::WriteStream.

Definition at line 60 of file WriteStreamSQLite.h.

62 {

Field Documentation

◆ db

sqlite3* souffle::WriteStreamSQLite::db = nullptr

private

Definition at line 284 of file WriteStreamSQLite.h.

◆ dbFilename

const std::string souffle::WriteStreamSQLite::dbFilename

private

Definition at line 276 of file WriteStreamSQLite.h.

◆ dbSymbolTable

std::unordered_map<uint64_t, uint64_t> souffle::WriteStreamSQLite::dbSymbolTable

private

Definition at line 280 of file WriteStreamSQLite.h.

◆ insertStatement

sqlite3_stmt* souffle::WriteStreamSQLite::insertStatement = nullptr

private

Definition at line 281 of file WriteStreamSQLite.h.

◆ relationName

const std::string souffle::WriteStreamSQLite::relationName

private

Definition at line 277 of file WriteStreamSQLite.h.

Referenced by createRelationView().

◆ symbolInsertStatement

sqlite3_stmt* souffle::WriteStreamSQLite::symbolInsertStatement = nullptr

private

Definition at line 282 of file WriteStreamSQLite.h.

◆ symbolSelectStatement

sqlite3_stmt* souffle::WriteStreamSQLite::symbolSelectStatement = nullptr

private

Definition at line 283 of file WriteStreamSQLite.h.

◆ symbolTableName

const std::string souffle::WriteStreamSQLite::symbolTableName = "__SymbolTable"

private

Definition at line 278 of file WriteStreamSQLite.h.

Referenced by createRelationView().

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

include/souffle/io/WriteStreamSQLite.h

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WriteStreamSQLite()

◆ ~WriteStreamSQLite()

Member Function Documentation

◆ createRelationTable()

◆ createRelationView()

◆ createSymbolTable()

◆ createTables()

◆ executeSQL()

◆ getFileName()

◆ getSymbolTableID()

◆ getSymbolTableIDFromDB()

◆ openDB()

◆ prepareInsertStatement()

◆ prepareStatements()

◆ prepareSymbolInsertStatement()

◆ prepareSymbolSelectStatement()

◆ throwError()

◆ writeNextTuple()

◆ writeNullary()

Field Documentation

◆ db

◆ dbFilename

◆ dbSymbolTable

◆ insertStatement

◆ relationName

◆ symbolInsertStatement

◆ symbolSelectStatement

◆ symbolTableName