sql_exchange.h

Go to the documentation of this file.

/* Copyright (c) 2017, 2025, Oracle and/or its affiliates.
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License, version 2.0,
   as published by the Free Software Foundation.
 
   This program is designed to work with certain software (including
   but not limited to OpenSSL) that is licensed under separate terms,
   as designated in a particular file or component or in included license
   documentation.  The authors of MySQL hereby grant you an additional
   permission to link the program and your derivative works with the
   separately licensed software that they have either included with
   the program or referenced in the documentation.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License, version 2.0, for more details.
 
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 
#ifndef SQL_EXCHANGE_INCLUDED
#define SQL_EXCHANGE_INCLUDED
 
struct CHARSET_INFO;
class String;
 
enum enum_source_type { LOAD_SOURCE_FILE, LOAD_SOURCE_URL, LOAD_SOURCE_S3 };
 
enum enum_filetype { FILETYPE_CSV, FILETYPE_XML };
 
/**
  Helper for the sql_exchange class
*/
 
struct Line_separators {
  const String *line_term;
  const String *line_start;
 
  void cleanup() { line_term = line_start = nullptr; }
  void merge_line_separators(const Line_separators &s) {
    if (s.line_term != nullptr) line_term = s.line_term;
    if (s.line_start != nullptr) line_start = s.line_start;
  }
};
 
/**
  Helper for the sql_exchange class
*/
 
struct Field_separators {
  const String *field_term;
  const String *escaped;
  const String *enclosed;
  bool opt_enclosed;
 
  void cleanup() {
    field_term = escaped = enclosed = nullptr;
    opt_enclosed = false;
  }
  void merge_field_separators(const Field_separators &s) {
    if (s.field_term != nullptr) field_term = s.field_term;
    if (s.escaped != nullptr) escaped = s.escaped;
    if (s.enclosed != nullptr) enclosed = s.enclosed;
    // TODO: a bug?
    // OPTIONALLY ENCLOSED BY x ENCLOSED BY y == OPTIONALLY ENCLOSED BY y
    if (s.opt_enclosed) opt_enclosed = s.opt_enclosed;
  }
};
 
/**
  Used to hold information about file and file structure in exchange
  via non-DB file (...INTO OUTFILE..., ...LOAD DATA...)
  XXX: We never call destructor for objects of this class.
*/
 
class sql_exchange final {
 public:
  Field_separators field;
  Line_separators line;
  enum enum_filetype filetype; /* load XML, Added by Arnold & Erik */
  const char *file_name;
  bool dumpfile;
  unsigned long skip_lines;
  const CHARSET_INFO *cs;
  sql_exchange(const char *name, bool dumpfile_flag,
               enum_filetype filetype_arg = FILETYPE_CSV);
  bool escaped_given(void);
};
 
#endif