DBCRUD

DBCRUD#

NAME#

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

SYNOPSIS#

All DBCRUD functions

PUBLIC INTERFACE#

new()#

create an object

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

DataAdd()#

add data to table

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

Returns:

my $Success = 1;

DataGet()#

get data attributes

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

Returns:

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

DataListGet()#

get list data with attributes

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

Returns:

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

DataSearch()#

search for value in defined attributes

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

Returns:

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

DataDelete()#

remove data from table

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

Returns:

my $Success = 1;

DataExport()#

exports data.

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

Returns:

my $Export = 'STRING';

DataImport()#

imports data.

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:

my $Success = 1;

InitConfig()#

init config for object

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

Returns:

my $Success = 1;
Contents