# This is how to create a new SQLConnString from the SQLConnString::create() function.
$sqlConn = SQLConnString::create(
        'MainDatabase', # Name of the SQLConnString.
        '127.0.0.1', # host/address of the server.
        'mainUser', # Username to connect.
        'mainUserPassword', # User password.
        'notifications', # Database used.
        3306, # Port of the server, set to 3306 by defaulté
        true); # If has to validate. Is set to true by default.

# This is how to create it from the functions within it.
$connString = new SQLConnString();
$connString->setName('MainDatabase');
$connString->setAddress('127.0.0.1');
$connString->setUsername('mainUser');
$connString->setPassword('mainUserPassword');
$connString->setDatabase('notifications');
$connString->setPort(3589); # 3306 is the default port if none is supplied.
$connString->validate();

MyPigSQL::registerStringConn($connString); # Returns true if successful

MyPigSQL::unregisterStringConn($connString); # Returns true if successful

MyPigSQL::getSQLConnStringByName($connName); # Returns SQLConnString object or throws SQLRequestException.
MyPigSQL::unregisterStringConn($SQLConnString); # Unregisters the SQLConnString object (must be supplied with the object).
MyPigSQL::unregisterStringConnByName($SQLConnStringName); # Unregisters the SQLConnString object by name.
MyPigSQL::registerStringConn($connString); # Registers the SQLConnString (must be supplied with the object).

# ['address' => $address, 'username' => $user, 'password' => $password, 'database' => $database, 'port' => $port]
MyPigSQL::validateConnString($connStringData); # Will validate the data to create a SQLConnString.

getName()}, you have {$data['kills'] kills!}"); } ); # This is how to create it from the functions within it. $request = new SQLRequest(); $request->setQuery("SELECT * FROM FriendRequests WHERE id = ?"); $request->setDataTypes('s'); $request->setDataKeys([$player->getUniqueId()->toString()]); $request->setConnString(MyPigSQL::getSQLConnStringByName('MainDatabase')); $request->setCallable(function(array $data) use ($player){ $player->sendMessage->('Wow, this is very fine! Here is when the relation has been created: ' . $data['reg_date']); }); # Here is a real-world example of a fully implemented command using MyPigSQL. /** * @param CommandSender $sender * @param string $commandLabel * @param array $args * @throws SQLRequestException */ public function execute(CommandSender $sender, string $commandLabel, array $args): void { if (!$sender->hasPermission(DefaultPermissions::ROOT_OPERATOR)) { $sender->sendMessage(Translation::getMessage('noPermission')); return; } if (!isset($args[1])) { $sender->sendMessage(Translation::getMessage('usageMessage', [ 'usage' => $this->getUsage() ])); return; } if (!is_numeric($args[1])) { $sender->sendMessage(Translation::getMessage('notNumeric')); return; } $player = $this->getCore()->getServer()->getPlayerExact($args[0]); MyPigSQL::addQueryToBatch(SQLRequest::create( 'UPDATE players SET shards = shards + ? WHERE username = ?', 'ss', [$args[1], $args[0]], MyPigSQL::getSQLConnStringByName('mainDB'), function(?array $data) use ($sender, $player, $args){ $name = $args[0]; if($player instanceof CorePlayer){ $player->addShards((int)$args[1]); $name = $player->getName(); } $sender->sendMessage(Translation::getMessage('addShardsSuccess', [ 'amount' => TF::GREEN . '' . $args[1], 'name' => TF::GOLD . $name ])); } )); }">

# This is how to create a new Utils from the Utils::create() function.
$requestTwo = SQLRequest::create(
        'SELECT * FROM PlayerData WHERE xuid = ?',
        's',
        [$player->getUniqueId()->toString()],
        self::getSQLConnStringByName('MainDatabase'),
        function (array $data) use ($player){
            $player->sendMessage("Welcome {$player->getName()}, you have {$data['kills'] kills!}");
        }
);
# This is how to create it from the functions within it.
$request = new SQLRequest();
$request->setQuery("SELECT * FROM FriendRequests WHERE id = ?");
$request->setDataTypes('s');
$request->setDataKeys([$player->getUniqueId()->toString()]);
$request->setConnString(MyPigSQL::getSQLConnStringByName('MainDatabase'));
$request->setCallable(function(array $data) use ($player){
        $player->sendMessage->('Wow, this is very fine! Here is when the relation has been created: ' . $data['reg_date']);
});

# Here is a real-world example of a fully implemented command using MyPigSQL.
    /**
     * @param CommandSender $sender
     * @param string $commandLabel
     * @param array $args
     * @throws SQLRequestException
     */
    public function execute(CommandSender $sender, string $commandLabel, array $args): void
    {
        if (!$sender->hasPermission(DefaultPermissions::ROOT_OPERATOR)) {
            $sender->sendMessage(Translation::getMessage('noPermission'));
            return;
        }
        if (!isset($args[1])) {
            $sender->sendMessage(Translation::getMessage('usageMessage', [
                'usage' => $this->getUsage()
            ]));
            return;
        }
        if (!is_numeric($args[1])) {
            $sender->sendMessage(Translation::getMessage('notNumeric'));
            return;
        }

        $player = $this->getCore()->getServer()->getPlayerExact($args[0]);
        MyPigSQL::addQueryToBatch(SQLRequest::create(
            'UPDATE players SET shards = shards + ? WHERE username = ?',
            'ss',
            [$args[1], $args[0]],
            MyPigSQL::getSQLConnStringByName('mainDB'),
            function(?array $data) use ($sender, $player, $args){
                $name = $args[0];
                if($player instanceof CorePlayer){
                    $player->addShards((int)$args[1]);
                    $name = $player->getName();
                }
                $sender->sendMessage(Translation::getMessage('addShardsSuccess', [
                    'amount' => TF::GREEN . '' . $args[1],
                    'name' => TF::GOLD . $name
                ]));
            }
        ));
    }

MyPigSQL::addQueryToBatch($request); # NOTE: MIGHT BE CHANGED TO addRequestToBatch().

MyPigSQL::addQueryToBatch($request); # Will register the request to the batch.
MyPigSQL::removeQueryFromBatch($id); # Will unset the request from the batch, must be supplied with the request's id.
MyPigSQL::getQueryFromBatch($id); # Will return the Utils object from the batch, must be supplied with the request's id.