OmniSciDB  6686921089
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
import_export::QueryExporterCSV Class Reference

#include <QueryExporterCSV.h>

+ Inheritance diagram for import_export::QueryExporterCSV:
+ Collaboration diagram for import_export::QueryExporterCSV:

Public Member Functions

 QueryExporterCSV ()
 
 ~QueryExporterCSV () override
 
void beginExport (const std::string &file_path, const std::string &layer_name, const CopyParams &copy_params, const std::vector< TargetMetaInfo > &column_infos, const FileCompression file_compression, const ArrayNullHandling array_null_handling) final
 
void exportResults (const std::vector< AggregatedResult > &query_results) final
 
void endExport () final
 
- Public Member Functions inherited from import_export::QueryExporter
 QueryExporter (const FileType file_type)
 
 QueryExporter ()=delete
 
virtual ~QueryExporter ()
 

Private Attributes

std::ofstream outfile_
 
CopyParams copy_params_
 

Additional Inherited Members

- Public Types inherited from import_export::QueryExporter
enum  FileType {
  FileType::kCSV, FileType::kGeoJSON, FileType::kGeoJSONL, FileType::kShapefile,
  FileType::kFlatGeobuf
}
 
enum  FileCompression { FileCompression::kNone, FileCompression::kGZip, FileCompression::kZip }
 
enum  ArrayNullHandling { ArrayNullHandling::kAbortWithWarning, ArrayNullHandling::kExportSentinels, ArrayNullHandling::kExportZeros, ArrayNullHandling::kNullEntireField }
 
- Static Public Member Functions inherited from import_export::QueryExporter
static std::unique_ptr
< QueryExporter
create (const FileType file_type)
 
- Protected Member Functions inherited from import_export::QueryExporter
void validateFileExtensions (const std::string &file_path, const std::string &file_type, const std::unordered_set< std::string > &valid_extensions) const
 
std::string safeColumnName (const std::string &resname, const int column_index)
 
- Protected Attributes inherited from import_export::QueryExporter
const FileType file_type_
 

Detailed Description

Definition at line 25 of file QueryExporterCSV.h.

Constructor & Destructor Documentation

import_export::QueryExporterCSV::QueryExporterCSV ( )
import_export::QueryExporterCSV::~QueryExporterCSV ( )
override

Definition at line 28 of file QueryExporterCSV.cpp.

28 {}

Member Function Documentation

void import_export::QueryExporterCSV::beginExport ( const std::string &  file_path,
const std::string &  layer_name,
const CopyParams copy_params,
const std::vector< TargetMetaInfo > &  column_infos,
const FileCompression  file_compression,
const ArrayNullHandling  array_null_handling 
)
finalvirtual

Implements import_export::QueryExporter.

Definition at line 30 of file QueryExporterCSV.cpp.

References copy_params_, import_export::CopyParams::delimiter, import_export::HAS_HEADER, import_export::CopyParams::has_header, import_export::QueryExporter::kNone, import_export::CopyParams::line_delim, outfile_, import_export::QueryExporter::safeColumnName(), and import_export::QueryExporter::validateFileExtensions().

35  {
36  validateFileExtensions(file_path, "CSV", {".csv", ".tsv"});
37 
38  // compression?
39  auto actual_file_path{file_path};
40  if (file_compression != FileCompression::kNone) {
41  // @TODO(se) implement post-export compression
42  throw std::runtime_error("Compression not yet supported for this file type");
43  }
44 
45  // open file
46  outfile_.open(actual_file_path);
47  if (!outfile_) {
48  throw std::runtime_error("Failed to create file '" + actual_file_path + "'");
49  }
50 
51  // write header?
52  if (copy_params.has_header == import_export::ImportHeaderRow::HAS_HEADER) {
53  bool not_first{false};
54  int column_index = 0;
55  for (auto const& column_info : column_infos) {
56  // get name or default
57  auto column_name = safeColumnName(column_info.get_resname(), column_index + 1);
58  // output to header line
59  if (not_first) {
60  outfile_ << copy_params.delimiter;
61  } else {
62  not_first = true;
63  }
64  outfile_ << column_name;
65  column_index++;
66  }
67  outfile_ << copy_params.line_delim;
68  }
69 
70  // keep these
71  copy_params_ = copy_params;
72 }
std::string safeColumnName(const std::string &resname, const int column_index)
void validateFileExtensions(const std::string &file_path, const std::string &file_type, const std::unordered_set< std::string > &valid_extensions) const

+ Here is the call graph for this function:

void import_export::QueryExporterCSV::endExport ( )
finalvirtual

Implements import_export::QueryExporter.

Definition at line 265 of file QueryExporterCSV.cpp.

References outfile_.

265  {
266  // just close the file
267  outfile_.close();
268 }
void import_export::QueryExporterCSV::exportResults ( const std::vector< AggregatedResult > &  query_results)
finalvirtual

Implements import_export::QueryExporter.

Definition at line 139 of file QueryExporterCSV.cpp.

References CHECK, CHECK_EQ, copy_params_, import_export::CopyParams::delimiter, import_export::CopyParams::escape, shared::formatHMS(), i, is_null(), kBIGINT, kBOOLEAN, kDATE, kFLOAT, kINT, kNUMERIC, kSMALLINT, kTIME, kTIMESTAMP, kTINYINT, import_export::CopyParams::line_delim, NULL_BIGINT, NULL_BOOLEAN, NULL_DOUBLE, NULL_FLOAT, NULL_INT, NULL_SMALLINT, import_export::CopyParams::null_str, NULL_TINYINT, outfile_, import_export::CopyParams::quote, import_export::CopyParams::quoted, and import_export::anonymous_namespace{QueryExporterCSV.cpp}::target_value_to_string().

139  {
140  for (auto& agg_result : query_results) {
141  auto results = agg_result.rs;
142  auto const& targets = agg_result.targets_meta;
143 
144  while (true) {
145  auto const crt_row = results->getNextRow(true, true);
146  if (crt_row.empty()) {
147  break;
148  }
149  bool not_first = false;
150  for (size_t i = 0; i < results->colCount(); ++i) {
151  bool is_null{false};
152  auto const tv = crt_row[i];
153  auto const scalar_tv = boost::get<ScalarTargetValue>(&tv);
154  if (not_first) {
156  } else {
157  not_first = true;
158  }
159  if (copy_params_.quoted) {
161  }
162  auto const& ti = targets[i].get_type_info();
163  if (!scalar_tv) {
164  outfile_ << target_value_to_string(crt_row[i], ti, " | ");
165  if (copy_params_.quoted) {
167  }
168  continue;
169  }
170  if (boost::get<int64_t>(scalar_tv)) {
171  auto int_val = *(boost::get<int64_t>(scalar_tv));
172  switch (ti.get_type()) {
173  case kBOOLEAN:
174  is_null = (int_val == NULL_BOOLEAN);
175  break;
176  case kTINYINT:
177  is_null = (int_val == NULL_TINYINT);
178  break;
179  case kSMALLINT:
180  is_null = (int_val == NULL_SMALLINT);
181  break;
182  case kINT:
183  is_null = (int_val == NULL_INT);
184  break;
185  case kBIGINT:
186  is_null = (int_val == NULL_BIGINT);
187  break;
188  case kTIME:
189  case kTIMESTAMP:
190  case kDATE:
191  is_null = (int_val == NULL_BIGINT);
192  break;
193  default:
194  is_null = false;
195  }
196  if (is_null) {
198  } else if (ti.get_type() == kTIME) {
199  constexpr size_t buf_size = 9;
200  char buf[buf_size];
201  size_t const len = shared::formatHMS(buf, buf_size, int_val);
202  CHECK_EQ(8u, len); // 8 == strlen("HH:MM:SS")
203  outfile_ << buf;
204  } else {
205  outfile_ << int_val;
206  }
207  } else if (boost::get<double>(scalar_tv)) {
208  auto real_val = *(boost::get<double>(scalar_tv));
209  if (ti.get_type() == kFLOAT) {
210  is_null = (real_val == NULL_FLOAT);
211  } else {
212  is_null = (real_val == NULL_DOUBLE);
213  }
214  if (is_null) {
216  } else if (ti.get_type() == kNUMERIC) {
217  outfile_ << std::setprecision(ti.get_precision()) << real_val;
218  } else {
219  outfile_ << std::setprecision(std::numeric_limits<double>::digits10 + 1)
220  << real_val;
221  }
222  } else if (boost::get<float>(scalar_tv)) {
223  CHECK_EQ(kFLOAT, ti.get_type());
224  auto real_val = *(boost::get<float>(scalar_tv));
225  if (real_val == NULL_FLOAT) {
227  } else {
228  outfile_ << std::setprecision(std::numeric_limits<float>::digits10 + 1)
229  << real_val;
230  }
231  } else {
232  auto s = boost::get<NullableString>(scalar_tv);
233  is_null = !s || boost::get<void*>(s);
234  if (is_null) {
236  } else {
237  auto s_notnull = boost::get<std::string>(s);
238  CHECK(s_notnull);
239  if (!copy_params_.quoted) {
240  outfile_ << *s_notnull;
241  } else {
242  size_t q = s_notnull->find(copy_params_.quote);
243  if (q == std::string::npos) {
244  outfile_ << *s_notnull;
245  } else {
246  std::string str(*s_notnull);
247  while (q != std::string::npos) {
248  str.insert(q, 1, copy_params_.escape);
249  q = str.find(copy_params_.quote, q + 2);
250  }
251  outfile_ << str;
252  }
253  }
254  }
255  }
256  if (copy_params_.quoted) {
258  }
259  }
261  }
262  }
263 }
#define CHECK_EQ(x, y)
Definition: Logger.h:217
#define NULL_DOUBLE
Definition: sqltypes.h:49
#define NULL_FLOAT
#define NULL_BIGINT
std::string target_value_to_string(const TargetValue &tv, const SQLTypeInfo &ti, const std::string &delim)
size_t formatHMS(char *buf, size_t const max, int64_t const unixtime)
Definition: misc.cpp:80
#define NULL_INT
CONSTEXPR DEVICE bool is_null(const T &value)
#define NULL_BOOLEAN
Definition: sqltypes.h:53
#define NULL_TINYINT
#define CHECK(condition)
Definition: Logger.h:209
#define NULL_SMALLINT
Definition: sqltypes.h:45

+ Here is the call graph for this function:

Member Data Documentation

CopyParams import_export::QueryExporterCSV::copy_params_
private

Definition at line 41 of file QueryExporterCSV.h.

Referenced by beginExport(), and exportResults().

std::ofstream import_export::QueryExporterCSV::outfile_
private

Definition at line 40 of file QueryExporterCSV.h.

Referenced by beginExport(), endExport(), and exportResults().


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