TSADBBase.h

/*  ===================================================================
*
*                 T R A D I N G   S Y S T E M   A P I ™
*    Copyright © 1999 - 2014 by Peter Ritter ( TradingSystemAPI.com )
*                A L L   R I G H T S   R E S E R V E D
*
*     Consult your license regarding permissions and restrictions.
*             You may obtain a copy of the License at:
*     http://www.TradingSystemAPI.com/licenses/LICENSE-TSAPI-3.0.html
*
*  ====================================================================
*/

#ifndef TSA_DB_BASE__INCLUDED
#define TSA_DB_BASE__INCLUDED

#include "TSATypeDef.h"
#include "TSADataDef.h"
#include "TSADBSeriesImport.h"
#include <string>

namespace tsa {

    class in_stream_adaptor;
    class out_stream_adaptor;
    class mem_table;
    class file_import_rules__obsolete;


    /*
    ** ====================================================
    ** >>>              class data_base                <<<
    ** ====================================================
    */

    class dll_export data_base : public tsa::object {
        std::string m_attach_name;
      public:

        data_base(void) { ; }

        virtual ~data_base(void) { ; }

        virtual std::string type(void)const = 0;

        // ????
        void attach_name(const std::string& name) { m_attach_name = name; }

        const std::string& attach_name(void)const { return m_attach_name; }

        void print_table_info(const std::string& table_name, std::ostream& stream);
      public:
        virtual in_stream_adaptor* make_input_stream_adaptor(const std::string& stream) = 0;
        virtual out_stream_adaptor* make_output_stream_adaptor(void) = 0;
      public:
         virtual bool table_record_count_is_known(void)const=0;

         virtual int64_t table_record_count(const std::string& table_name) = 0;

        virtual date_time series_table_first_timestamp(const std::string& table_name) = 0;

        virtual date_time series_table_last_timestamp(const std::string& table_name) = 0;

        virtual bool table_has_data(const std::string& table_name) = 0;

        virtual tsa::column_defs series_table_column_defs(const std::string& table_name) = 0;

        virtual date_time series_table_closest_timestamp_LOE(const date_time& target, const std::string& table_name) = 0;

        virtual void series_load(const std::string& table_name, tsa::mem_table& mtable,
                                 const date_time& from_timestamp, size_t num_records) = 0;

        bool series_columns_match(const std::string& table_name, const tsa::mem_table& m_table);

        virtual void series_append(const std::string& table_name, const tsa::mem_table& m_table) = 0;

        virtual void create_series_table(const std::string& table_name, const tsa::column_defs& columns) = 0;

        virtual bool table_exists(const std::string& table_name) const = 0;

        virtual bool drop_series_table(const std::string& table_name) = 0;

        virtual void truncate_series_table(const std::string& table_name, 
            const date_time& new_max_timestamp = date_time::min) = 0;

        void import(const file_import_rules__obsolete& import_properties);

        void import(const file_import_params& import_properties);

        void copy_table_from(data_base& source_db, const std::string& source_table_name, 
            const std::string& target_table_name, const table_copy_params& copy_prop = table_copy_params());

        // internal use
        void fill_random(const std::string& table_name, const date_time& start_timestamp, const date_time& end_timestamp,
            const duration& step, bool some_as_nil = true, size_t max_num_records = tsa::max_size_limit);

        // internal use
        void fill_random_series(const std::string& table_name, const date_time& start_timestamp, const date_time& end_timestamp,
            const duration& step, size_t max_num_records = tsa::max_size_limit);
      private:
         void raise__not_implemented(void) const {
             throw tsa::exception(class_name(), "not implemented", SLOC);
         }
    };


}

#endif