44constexpr char const *gSQliteVfsName =
"ROOT-Davix-readonly";
53 VfsRootFile() =
default;
56 std::unique_ptr<ROOT::Internal::RRawFile> fRawFile;
63int VfsRdOnlyClose(sqlite3_file *pFile)
65 VfsRootFile *p =
reinterpret_cast<VfsRootFile *
>(pFile);
73int VfsRdOnlyRead(sqlite3_file *pFile,
void *zBuf,
int count, sqlite_int64 offset)
75 VfsRootFile *p =
reinterpret_cast<VfsRootFile *
>(pFile);
76 auto nbytes = p->fRawFile->ReadAt(zBuf, count, offset);
77 return (nbytes !=
static_cast<unsigned int>(count)) ? SQLITE_IOERR : SQLITE_OK;
82int VfsRdOnlyWrite(sqlite3_file * ,
const void * ,
int , sqlite_int64 )
84 return SQLITE_OPEN_READONLY;
89int VfsRdOnlyTruncate(sqlite3_file * , sqlite_int64 )
91 return SQLITE_OPEN_READONLY;
96int VfsRdOnlySync(sqlite3_file * ,
int )
103int VfsRdOnlyFileSize(sqlite3_file *pFile, sqlite_int64 *pSize)
105 VfsRootFile *p =
reinterpret_cast<VfsRootFile *
>(pFile);
106 *pSize = p->fRawFile->GetSize();
112int VfsRdOnlyLock(sqlite3_file * ,
int )
119int VfsRdOnlyUnlock(sqlite3_file * ,
int )
126int VfsRdOnlyCheckReservedLock(sqlite3_file * ,
int *pResOut)
134int VfsRdOnlyFileControl(sqlite3_file * ,
int ,
void * )
136 return SQLITE_NOTFOUND;
141int VfsRdOnlySectorSize(sqlite3_file * )
143 return SQLITE_OPEN_READONLY;
148int VfsRdOnlyDeviceCharacteristics(sqlite3_file * )
150 return SQLITE_OPEN_READONLY;
156sqlite3_io_methods GetSqlite3IoMethods()
160 sqlite3_io_methods io_methods;
161 memset(&io_methods, 0,
sizeof(io_methods));
162 io_methods.iVersion = 1;
163 io_methods.xClose = VfsRdOnlyClose;
164 io_methods.xRead = VfsRdOnlyRead;
165 io_methods.xWrite = VfsRdOnlyWrite;
166 io_methods.xTruncate = VfsRdOnlyTruncate;
167 io_methods.xSync = VfsRdOnlySync;
168 io_methods.xFileSize = VfsRdOnlyFileSize;
169 io_methods.xLock = VfsRdOnlyLock;
170 io_methods.xUnlock = VfsRdOnlyUnlock;
171 io_methods.xCheckReservedLock = VfsRdOnlyCheckReservedLock;
172 io_methods.xFileControl = VfsRdOnlyFileControl;
173 io_methods.xSectorSize = VfsRdOnlySectorSize;
174 io_methods.xDeviceCharacteristics = VfsRdOnlyDeviceCharacteristics;
180int VfsRdOnlyOpen(sqlite3_vfs * ,
const char *zName, sqlite3_file *pFile,
int flags,
int * )
183 VfsRootFile *p =
new (pFile) VfsRootFile();
184 p->pFile.pMethods =
nullptr;
188 static const sqlite3_io_methods io_methods = GetSqlite3IoMethods();
190 if (flags & (SQLITE_OPEN_READWRITE | SQLITE_OPEN_DELETEONCLOSE | SQLITE_OPEN_EXCLUSIVE))
195 ::Error(
"VfsRdOnlyOpen",
"Cannot open %s\n", zName);
199 p->pFile.pMethods = &io_methods;
209int VfsRdOnlyDelete(sqlite3_vfs * ,
const char * ,
int )
211 return SQLITE_IOERR_DELETE;
216int VfsRdOnlyAccess(sqlite3_vfs * ,
const char * ,
int flags,
int *pResOut)
219 if (flags == SQLITE_ACCESS_READWRITE) {
220 return SQLITE_OPEN_READONLY;
227int VfsRdOnlyFullPathname(sqlite3_vfs * ,
const char *zPath,
int nOut,
char *zOut)
229 zOut[nOut - 1] =
'\0';
230 sqlite3_snprintf(nOut, zOut,
"%s", zPath);
236int VfsRdOnlyRandomness(sqlite3_vfs * ,
int nBuf,
char *zBuf)
238 for (
int i = 0; i < nBuf; ++i) {
239 zBuf[i] = (char)
gRandom->Integer(256);
246int VfsRdOnlySleep(sqlite3_vfs * ,
int microseconds)
249 gSystem->Sleep((microseconds + 1000 - 1) / 1000);
255int VfsRdOnlyGetLastError(sqlite3_vfs * ,
int ,
char * )
262int VfsRdOnlyCurrentTimeInt64(sqlite3_vfs * , sqlite3_int64 *piNow)
264 static constexpr sqlite3_int64 unixEpoch = 24405875 * (sqlite3_int64)8640000;
267 *piNow = ((sqlite3_int64)t) * 1000 + unixEpoch;
273int VfsRdOnlyCurrentTime(sqlite3_vfs *vfs,
double *prNow)
276 int rc = VfsRdOnlyCurrentTimeInt64(vfs, &i);
277 *prNow = i / 86400000.0;
284sqlite3_vfs GetSqlite3Vfs()
289 memset(&vfs, 0,
sizeof(vfs));
291 vfs.szOsFile =
sizeof(VfsRootFile);
292 vfs.mxPathname = 2000;
293 vfs.zName = gSQliteVfsName;
294 vfs.xOpen = VfsRdOnlyOpen;
295 vfs.xDelete = VfsRdOnlyDelete;
296 vfs.xAccess = VfsRdOnlyAccess;
297 vfs.xFullPathname = VfsRdOnlyFullPathname;
298 vfs.xRandomness = VfsRdOnlyRandomness;
299 vfs.xSleep = VfsRdOnlySleep;
300 vfs.xCurrentTime = VfsRdOnlyCurrentTime;
301 vfs.xGetLastError = VfsRdOnlyGetLastError;
307struct sqlite3_vfs kSqlite3Vfs = GetSqlite3Vfs();
309bool RegisterSqliteVfs()
312 retval = sqlite3_vfs_register(&kSqlite3Vfs,
false);
313 return (retval == SQLITE_OK);
340 default:
throw std::runtime_error(
"Internal error");
355 static bool hasSqliteVfs = RegisterSqliteVfs();
357 throw std::runtime_error(
"Cannot register SQlite VFS in RSqliteDS");
361 retval = sqlite3_open_v2(fileName.c_str(), &
fDataSet->fDb, SQLITE_OPEN_READONLY | SQLITE_OPEN_NOMUTEX,
363 if (retval != SQLITE_OK)
371 retval = sqlite3_exec(
fDataSet->fDb,
"PRAGMA temp_store=2;",
nullptr,
nullptr,
nullptr);
372 if (retval != SQLITE_OK)
375 retval = sqlite3_prepare_v2(
fDataSet->fDb, query.c_str(), -1, &
fDataSet->fQuery,
nullptr);
376 if (retval != SQLITE_OK)
379 int colCount = sqlite3_column_count(
fDataSet->fQuery);
380 retval = sqlite3_step(
fDataSet->fQuery);
381 if ((retval != SQLITE_ROW) && (retval != SQLITE_DONE))
385 for (
int i = 0; i < colCount; ++i) {
387 int type = SQLITE_NULL;
390 const char *declTypeCstr = sqlite3_column_decltype(
fDataSet->fQuery, i);
391 if (declTypeCstr ==
nullptr) {
392 if (retval == SQLITE_ROW)
395 std::string declType(declTypeCstr);
396 std::transform(declType.begin(), declType.end(), declType.begin(), ::toupper);
397 if (declType ==
"INTEGER")
398 type = SQLITE_INTEGER;
399 else if (declType ==
"FLOAT")
401 else if (declType ==
"TEXT")
403 else if (declType ==
"BLOB")
406 throw std::runtime_error(
"Unexpected column decl type");
431 default:
throw std::runtime_error(
"Unhandled data type");
469 std::vector<std::pair<ULong64_t, ULong64_t>> entryRanges;
470 int retval = sqlite3_step(
fDataSet->fQuery);
472 case SQLITE_DONE:
return entryRanges;
490 for (
unsigned i = 0; i <
N; ++i) {
495 throw std::runtime_error(
"Unknown column: " + std::string(colName));
510 int retval = sqlite3_reset(
fDataSet->fQuery);
511 if (retval != SQLITE_OK)
512 throw std::runtime_error(
"SQlite error, reset");
526 ROOT::RDataFrame rdf(std::make_unique<RSqliteDS>(std::string(fileName), std::string(query)));
534 assert(entry + 1 ==
fNRow);
537 for (
unsigned i = 0; i <
N; ++i) {
546 nbytes = sqlite3_column_bytes(
fDataSet->fQuery, i);
550 fValues[i].fText =
reinterpret_cast<const char *
>(sqlite3_column_text(
fDataSet->fQuery, i));
554 nbytes = sqlite3_column_bytes(
fDataSet->fQuery, i);
555 fValues[i].fBlob.resize(nbytes);
557 std::memcpy(
fValues[i].fBlob.data(), sqlite3_column_blob(
fDataSet->fQuery, i), nbytes);
561 default:
throw std::runtime_error(
"Unhandled column type");
572 ::Warning(
"SetNSlots",
"Currently the SQlite data source faces performance degradation in multi-threaded mode. "
573 "Consider turning off IMT.");
582 std::string errmsg =
"SQlite error: ";
583#if SQLITE_VERSION_NUMBER < 3007015
584 errmsg += std::to_string(errcode);
586 errmsg += sqlite3_errstr(errcode);
588 throw std::runtime_error(errmsg);
595std::unique_ptr<ROOT::Detail::RDF::RColumnReaderBase>
600 throw std::runtime_error(
"Column \"" + std::string(colName) +
"\" is not available in the SQLite table.");
602 const auto index = std::distance(
fColumnNames.begin(), colNameIt);
609 throw std::runtime_error(
"The type selected for column \"" + std::string(colName) +
610 "\" does not correspond to column type, which is \"" +
GetTypeName(colName) +
"\".");
613 fValues[index].fIsActive =
true;
615 return std::make_unique<ROOT::Internal::RDF::RSqliteDSColumnReader>(
fValues[index].fPtr);
long long Long64_t
Portable signed long integer 8 bytes.
unsigned long long ULong64_t
Portable unsigned long integer 8 bytes.
Error("WriteTObject","The current directory (%s) is not associated with a file. The object (%s) has not been written.", GetName(), objname)
void Warning(const char *location, const char *msgfmt,...)
Use this function in warning situations.
static std::unique_ptr< RRawFile > Create(std::string_view url, ROptions options=ROptions())
Factory method that returns a suitable concrete implementation according to the transport in the url.
std::vector< void * > Record_t
void SetNSlots(unsigned int nSlots) final
Almost a no-op, many slots can in fact reduce the performance due to thread synchronization.
static constexpr char const * fgTypeNames[]
Corresponds to the types defined in ETypes.
std::string GetLabel() final
Return a string representation of the datasource type.
std::unique_ptr< ROOT::Detail::RDF::RColumnReaderBase > GetColumnReaders(unsigned int slot, std::string_view colName, const std::type_info &tid) final
If the other GetColumnReaders overload returns an empty vector, this overload will be called instead.
std::vector< std::string > fColumnNames
bool HasColumn(std::string_view colName) const final
A linear search through the columns for the given name.
void Initialize() final
Resets the SQlite query engine at the beginning of the event loop.
std::vector< ETypes > fColumnTypes
std::string GetTypeName(std::string_view colName) const final
Returns the C++ type for a given column name, implemented as a linear search through all the columns.
ETypes
All the types known to SQlite. Changes require changing fgTypeNames, too.
Record_t GetColumnReadersImpl(std::string_view name, const std::type_info &) final
Activates the given column's result value.
RSqliteDS(const std::string &fileName, const std::string &query)
Build the dataframe.
std::unique_ptr< Internal::RSqliteDSDataSet > fDataSet
std::vector< std::pair< ULong64_t, ULong64_t > > GetEntryRanges() final
Returns a range of size 1 as long as more rows are available in the SQL result set.
const std::vector< std::string > & GetColumnNames() const final
Returns the SELECT queries names.
bool SetEntry(unsigned int slot, ULong64_t entry) final
Stores the result of the current active sqlite query row as a C++ value.
~RSqliteDS() final
Frees the sqlite resources and closes the file.
void SqliteError(int errcode)
Helper function to throw an exception if there is a fatal sqlite error, e.g. an I/O error.
std::vector< Value_t > fValues
The data source is inherently single-threaded and returns only one row at a time. This vector holds t...
ROOT's RDataFrame offers a modern, high-level interface for analysis of data stored in TTree ,...
RDataFrame FromSqlite(std::string_view fileName, std::string_view query)
Factory method to create a SQlite RDataFrame.
The state of an open dataset in terms of the sqlite3 C library.
void * fPtr
Points to one of the values; an address to this pointer is returned by GetColumnReadersImpl.
std::vector< unsigned char > fBlob
bool fIsActive
Not all columns of the query are necessarily used by the RDF. Allows for skipping them.