320 lines
9.2 KiB
C++
320 lines
9.2 KiB
C++
/*
|
|
* This file contains the implementation of an SQLite virtual table for
|
|
* reading Parquet files.
|
|
*
|
|
* Usage:
|
|
*
|
|
* .load ./parquet
|
|
* CREATE VIRTUAL TABLE demo USING parquet(FILENAME);
|
|
* SELECT * FROM demo;
|
|
*
|
|
*/
|
|
#include <sqlite3ext.h>
|
|
SQLITE_EXTENSION_INIT1
|
|
#include <string.h>
|
|
#include <stdlib.h>
|
|
#include <assert.h>
|
|
#include <stdarg.h>
|
|
#include <ctype.h>
|
|
#include <stdio.h>
|
|
|
|
#include <memory>
|
|
|
|
#include "parquet_table.h"
|
|
#include "parquet_cursor.h"
|
|
|
|
/* Forward references to the various virtual table methods implemented
|
|
* in this file. */
|
|
static int parquetCreate(sqlite3*, void*, int, const char*const*,
|
|
sqlite3_vtab**,char**);
|
|
static int parquetConnect(sqlite3*, void*, int, const char*const*,
|
|
sqlite3_vtab**,char**);
|
|
static int parquetBestIndex(sqlite3_vtab*,sqlite3_index_info*);
|
|
static int parquetDisconnect(sqlite3_vtab*);
|
|
static int parquetOpen(sqlite3_vtab*, sqlite3_vtab_cursor**);
|
|
static int parquetClose(sqlite3_vtab_cursor*);
|
|
static int parquetFilter(sqlite3_vtab_cursor*, int idxNum, const char *idxStr,
|
|
int argc, sqlite3_value **argv);
|
|
static int parquetNext(sqlite3_vtab_cursor*);
|
|
static int parquetEof(sqlite3_vtab_cursor*);
|
|
static int parquetColumn(sqlite3_vtab_cursor*,sqlite3_context*,int);
|
|
static int parquetRowid(sqlite3_vtab_cursor*,sqlite3_int64*);
|
|
|
|
/* An instance of the Parquet virtual table */
|
|
typedef struct sqlite3_vtab_parquet {
|
|
sqlite3_vtab base; /* Base class. Must be first */
|
|
ParquetTable* table;
|
|
} sqlite3_vtab_parquet;
|
|
|
|
|
|
/* A cursor for the Parquet virtual table */
|
|
typedef struct sqlite3_vtab_cursor_parquet {
|
|
sqlite3_vtab_cursor base; /* Base class. Must be first */
|
|
ParquetCursor* cursor;
|
|
} sqlite3_vtab_cursor_parquet;
|
|
|
|
/*
|
|
** This method is the destructor fo a sqlite3_vtab_parquet object.
|
|
*/
|
|
static int parquetDisconnect(sqlite3_vtab *pVtab){
|
|
sqlite3_vtab_parquet *p = (sqlite3_vtab_parquet*)pVtab;
|
|
delete p->table;
|
|
sqlite3_free(p);
|
|
return SQLITE_OK;
|
|
}
|
|
|
|
static int parquetConnect(
|
|
sqlite3 *db,
|
|
void *pAux,
|
|
int argc,
|
|
const char *const*argv,
|
|
sqlite3_vtab **ppVtab,
|
|
char **pzErr
|
|
){
|
|
if(argc != 4 || strlen(argv[3]) < 2) {
|
|
*pzErr = sqlite3_mprintf("must provide exactly one argument, the path to a parquet file");
|
|
return SQLITE_ERROR;
|
|
}
|
|
|
|
// Remove the delimiting single quotes
|
|
std::string fname = argv[3];
|
|
fname = fname.substr(1, fname.length() - 2);
|
|
std::unique_ptr<ParquetTable> table(new ParquetTable(fname));
|
|
|
|
std::unique_ptr<sqlite3_vtab_parquet, void(*)(void*)> vtab(
|
|
(sqlite3_vtab_parquet*)sqlite3_malloc(sizeof(sqlite3_vtab_parquet)),
|
|
sqlite3_free);
|
|
memset(vtab.get(), 0, sizeof(*vtab.get()));
|
|
|
|
try {
|
|
std::string create = table->CreateStatement();
|
|
int rc = sqlite3_declare_vtab(db, create.data());
|
|
if(rc)
|
|
return rc;
|
|
|
|
} catch (const std::exception& e) {
|
|
*pzErr = sqlite3_mprintf(e.what());
|
|
return SQLITE_ERROR;
|
|
}
|
|
|
|
vtab->table = table.release();
|
|
*ppVtab = (sqlite3_vtab*)vtab.release();
|
|
return SQLITE_OK;
|
|
}
|
|
|
|
/*
|
|
** The xConnect and xCreate methods do the same thing, but they must be
|
|
** different so that the virtual table is not an eponymous virtual table.
|
|
*/
|
|
static int parquetCreate(
|
|
sqlite3 *db,
|
|
void *pAux,
|
|
int argc, const char *const*argv,
|
|
sqlite3_vtab **ppVtab,
|
|
char **pzErr
|
|
){
|
|
return parquetConnect(db, pAux, argc, argv, ppVtab, pzErr);
|
|
}
|
|
|
|
/*
|
|
** Destructor for a sqlite3_vtab_cursor_parquet.
|
|
*/
|
|
static int parquetClose(sqlite3_vtab_cursor *cur){
|
|
sqlite3_vtab_cursor_parquet* p = (sqlite3_vtab_cursor_parquet*)cur;
|
|
delete p->cursor;
|
|
sqlite3_free(cur);
|
|
return SQLITE_OK;
|
|
}
|
|
|
|
/*
|
|
** Constructor for a new sqlite3_vtab_parquet cursor object.
|
|
*/
|
|
static int parquetOpen(sqlite3_vtab *p, sqlite3_vtab_cursor **ppCursor){
|
|
printf("xOpen\n");
|
|
|
|
std::unique_ptr<sqlite3_vtab_cursor_parquet, void(*)(void*)> cursor(
|
|
(sqlite3_vtab_cursor_parquet*)sqlite3_malloc(sizeof(sqlite3_vtab_cursor_parquet)),
|
|
sqlite3_free);
|
|
memset(cursor.get(), 0, sizeof(*cursor.get()));
|
|
|
|
sqlite3_vtab_parquet* pParquet = (sqlite3_vtab_parquet*)p;
|
|
cursor->cursor = new ParquetCursor(pParquet->table);
|
|
|
|
*ppCursor = (sqlite3_vtab_cursor*)cursor.release();
|
|
return SQLITE_OK;
|
|
}
|
|
|
|
|
|
/*
|
|
** Advance a sqlite3_vtab_cursor_parquet to its next row of input.
|
|
** Set the EOF marker if we reach the end of input.
|
|
*/
|
|
static int parquetNext(sqlite3_vtab_cursor *cur){
|
|
ParquetCursor* cursor = ((sqlite3_vtab_cursor_parquet*)cur)->cursor;
|
|
cursor->next();
|
|
return SQLITE_OK;
|
|
}
|
|
|
|
/*
|
|
** Return values of columns for the row at which the sqlite3_vtab_cursor_parquet
|
|
** is currently pointing.
|
|
*/
|
|
static int parquetColumn(
|
|
sqlite3_vtab_cursor *cur, /* The cursor */
|
|
sqlite3_context *ctx, /* First argument to sqlite3_result_...() */
|
|
int col /* Which column to return */
|
|
){
|
|
ParquetCursor *cursor = ((sqlite3_vtab_cursor_parquet*)cur)->cursor;
|
|
cursor->ensureColumn(col);
|
|
|
|
if(cursor->isNull(col)) {
|
|
sqlite3_result_null(ctx);
|
|
} else {
|
|
switch(cursor->getPhysicalType(col)) {
|
|
case parquet::Type::BOOLEAN:
|
|
case parquet::Type::INT32:
|
|
{
|
|
int rv = cursor->getInt32(col);
|
|
sqlite3_result_int(ctx, rv);
|
|
break;
|
|
}
|
|
case parquet::Type::DOUBLE:
|
|
{
|
|
double rv = cursor->getDouble(col);
|
|
sqlite3_result_double(ctx, rv);
|
|
break;
|
|
}
|
|
case parquet::Type::BYTE_ARRAY:
|
|
{
|
|
parquet::ByteArray* rv = cursor->getByteArray(col);
|
|
sqlite3_result_text(ctx, (const char*)rv->ptr, rv->len, SQLITE_TRANSIENT);
|
|
break;
|
|
}
|
|
case parquet::Type::INT96:
|
|
// This type exists to store timestamps in nanoseconds due to legacy
|
|
// reasons. We just interpret it as a timestamp in milliseconds.
|
|
case parquet::Type::INT64:
|
|
{
|
|
long rv = cursor->getInt64(col);
|
|
sqlite3_result_int64(ctx, rv);
|
|
break;
|
|
}
|
|
case parquet::Type::FLOAT:
|
|
case parquet::Type::FIXED_LEN_BYTE_ARRAY:
|
|
default:
|
|
// Should be impossible to get here as we should have forbidden this at
|
|
// CREATE time -- maybe file changed underneath us?
|
|
std::ostringstream ss;
|
|
ss << __FILE__ << ":" << __LINE__ << ": column " << col << " has unsupported type: " <<
|
|
parquet::TypeToString(cursor->getPhysicalType(col));
|
|
|
|
throw std::invalid_argument(ss.str());
|
|
break;
|
|
}
|
|
}
|
|
return SQLITE_OK;
|
|
}
|
|
|
|
/*
|
|
** Return the rowid for the current row.
|
|
*/
|
|
static int parquetRowid(sqlite3_vtab_cursor *cur, sqlite_int64 *pRowid){
|
|
ParquetCursor *cursor = ((sqlite3_vtab_cursor_parquet*)cur)->cursor;
|
|
*pRowid = cursor->getRowId();
|
|
return SQLITE_OK;
|
|
}
|
|
|
|
/*
|
|
** Return TRUE if the cursor has been moved off of the last
|
|
** row of output.
|
|
*/
|
|
static int parquetEof(sqlite3_vtab_cursor *cur){
|
|
ParquetCursor* cursor = ((sqlite3_vtab_cursor_parquet*)cur)->cursor;
|
|
if(cursor->eof())
|
|
return 1;
|
|
return 0;
|
|
}
|
|
|
|
/*
|
|
** Only a full table scan is supported. So xFilter simply rewinds to
|
|
** the beginning.
|
|
*/
|
|
static int parquetFilter(
|
|
sqlite3_vtab_cursor *pVtabCursor,
|
|
int idxNum, const char *idxStr,
|
|
int argc, sqlite3_value **argv
|
|
){
|
|
printf("xFilter\n");
|
|
//sqlite3_vtab_cursor_parquet *pCur = (sqlite3_vtab_cursor_parquet*)pVtabCursor;
|
|
//sqlite3_vtab_parquet *pTab = (sqlite3_vtab_parquet*)pVtabCursor->pVtab;
|
|
|
|
/*
|
|
pCur->iRowid = 0;
|
|
if( pCur->rdr.in==0 ){
|
|
assert( pCur->rdr.zIn==pTab->zData );
|
|
assert( pTab->iStart>=0 );
|
|
assert( (size_t)pTab->iStart<=pCur->rdr.nIn );
|
|
pCur->rdr.iIn = pTab->iStart;
|
|
}else{
|
|
fseek(pCur->rdr.in, pTab->iStart, SEEK_SET);
|
|
pCur->rdr.iIn = 0;
|
|
pCur->rdr.nIn = 0;
|
|
}
|
|
*/
|
|
return parquetNext(pVtabCursor);
|
|
}
|
|
|
|
/*
|
|
* Only a forward full table scan is supported. xBestIndex is mostly
|
|
* a no-op.
|
|
*/
|
|
static int parquetBestIndex(
|
|
sqlite3_vtab *tab,
|
|
sqlite3_index_info *pIdxInfo
|
|
){
|
|
pIdxInfo->estimatedCost = 1000000;
|
|
return SQLITE_OK;
|
|
}
|
|
|
|
|
|
static sqlite3_module ParquetModule = {
|
|
0, /* iVersion */
|
|
parquetCreate, /* xCreate */
|
|
parquetConnect, /* xConnect */
|
|
parquetBestIndex, /* xBestIndex */
|
|
parquetDisconnect, /* xDisconnect */
|
|
parquetDisconnect, /* xDestroy */
|
|
parquetOpen, /* xOpen - open a cursor */
|
|
parquetClose, /* xClose - close a cursor */
|
|
parquetFilter, /* xFilter - configure scan constraints */
|
|
parquetNext, /* xNext - advance a cursor */
|
|
parquetEof, /* xEof - check for end of scan */
|
|
parquetColumn, /* xColumn - read data */
|
|
parquetRowid, /* xRowid - read data */
|
|
0, /* xUpdate */
|
|
0, /* xBegin */
|
|
0, /* xSync */
|
|
0, /* xCommit */
|
|
0, /* xRollback */
|
|
0, /* xFindMethod */
|
|
0, /* xRename */
|
|
};
|
|
|
|
/*
|
|
* This routine is called when the extension is loaded. The new
|
|
* Parquet virtual table module is registered with the calling database
|
|
* connection.
|
|
*/
|
|
extern "C" {
|
|
int sqlite3_parquet_init(
|
|
sqlite3 *db,
|
|
char **pzErrMsg,
|
|
const sqlite3_api_routines *pApi
|
|
){
|
|
int rc;
|
|
SQLITE_EXTENSION_INIT2(pApi);
|
|
rc = sqlite3_create_module(db, "parquet", &ParquetModule, 0);
|
|
return rc;
|
|
}
|
|
}
|