######
DBCRUD
######


****
NAME
****


Kernel::System::UnitTest::DBCRUD - DBCRUD test lib


********
SYNOPSIS
********


All DBCRUD functions


****************
PUBLIC INTERFACE
****************


new()
=====


create an object


.. code-block:: perl

     my $DBCRUDTestObject = $Kernel::OM->Get('Kernel::System::UnitTest::DBCRUD');



DataAdd()
=========


add data to table


.. code-block:: perl

     my $Success = $DBCRUDTestObject->DataAdd(
         ID          => '...',
         Name        => '...', # optional
         Age         => '...', # optional
         Description => '...', # optional
         ContentJSON => '...', # optional
         CreateTime  => '...', # optional
         ChangeTime  => '...', # optional
     );


Returns:


.. code-block:: perl

     my $Success = 1;



DataGet()
=========


get data attributes


.. code-block:: perl

     my %Data = $DBCRUDTestObject->DataGet(
         ID          => '...', # optional
         Name        => '...', # optional
         Age         => '...', # optional
         Description => '...', # optional
         ContentJSON => '...', # optional
         CreateTime  => '...', # optional
         ChangeTime  => '...', # optional
     );


Returns:


.. code-block:: perl

     my %Data = (
         ID          => '...',
         Name        => '...',
         Age         => '...',
         Description => '...',
         ContentJSON => '...',
         CreateTime  => '...',
         ChangeTime  => '...',
     );



DataListGet()
=============


get list data with attributes


.. code-block:: perl

     my @Data = $DBCRUDTestObject->DataListGet(
         ID          => '...', # optional
         Name        => '...', # optional
         Age         => '...', # optional
         Description => '...', # optional
         ContentJSON => '...', # optional
         CreateTime  => '...', # optional
         ChangeTime  => '...', # optional
     );


Returns:


.. code-block:: perl

     my @Data = (
         {
             ID          => '...',
             Name        => '...',
             Age         => '...',
             Description => '...',
             ContentJSON => '...',
             CreateTime  => '...',
             ChangeTime  => '...',
         },
         # ...
     );



DataSearch()
============


search for value in defined attributes


.. code-block:: perl

     my %Data = $DBCRUDTestObject->DataSearch(
         Search      => 'test*test',
         ID          => '...', # optional
         Name        => '...', # optional
         Age         => '...', # optional
         Description => '...', # optional
         ContentJSON => '...', # optional
         CreateTime  => '...', # optional
         ChangeTime  => '...', # optional
     );


Returns:


.. code-block:: perl

     my %Data = (
         '1' => {
             ID          => '...',
             Name        => '...',
             Age         => '...',
             Description => '...',
             ContentJSON => '...',
             CreateTime  => '...',
             ChangeTime  => '...',
         },
         # ...
     );



DataDelete()
============


remove data from table


.. code-block:: perl

     my $Success = $DBCRUDTestObject->DataDelete(
         ID          => '...', # optional
         Name        => '...', # optional
         Age         => '...', # optional
         Description => '...', # optional
         ContentJSON => '...', # optional
         CreateTime  => '...', # optional
         ChangeTime  => '...', # optional
     );


Returns:


.. code-block:: perl

     my $Success = 1;



DataExport()
============


exports data.


.. code-block:: perl

     my $Export = $DBCRUDTestObject->DataExport(
         Format => 'yml',
         Cache  => 0,
     );


Returns:


.. code-block:: perl

     my $Export = 'STRING';



DataImport()
============


imports data.


.. code-block:: perl

     my $Success = $DBCRUDTestObject->DataImport(
         Content   => $ContentString,
         Format    => 'yml',                 # optional - default
         Overwrite => 1,                     # optional to overwrite existing data
         Data      => {                      # additional data if not all needed data exists
             ValidID => 1,
         }
     );


Returns:


.. code-block:: perl

     my $Success = 1;



InitConfig()
============


init config for object


.. code-block:: perl

     my $Success = $DBCRUDTestObject->InitConfig();


Returns:


.. code-block:: perl

     my $Success = 1;