experteam/api-redis-bundle

REDIS functionality bundle for APIs.

1.0.26 2021-05-27 17:09 UTC

README

Redis Services for APIs in Symfony 5.1+
It includes:

  • Redis Client: Predis client wrapper for writing and reading in redis.
  • Redis Transport: Service to save entities in redis and dispatch message queues.

Install

  1. Run de following composer command:
composer require experteam/api-redis-bundle
  1. Create the configuration file through any of the following options:

    a. Manually copy the example file in the package root to the folder config/packages/.

    b. Copy the vendor_copy.php file to the root of the project and configure the scripts in the composer.json file:

    "scripts": {
         "vendor-scripts": [
             "@php vendor_copy.php -s vendor/experteam/api-redis-bundle/experteam_api_redis.yaml.example -d config/packages/experteam_api_redis.yaml --not-overwrite --ignore-no-source"
         ],
         "post-install-cmd": [
             "@vendor-scripts"
         ],
         "post-update-cmd": [
             "@vendor-scripts"
         ]
     },
    
  2. Edit the bundle configuration file config/packages/experteam_api_redis.yaml:

experteam_api_redis:
    serialize_groups:
        save: read
        message: read
    elk_logger:
        save: true
        message: true
    entities:
        [Entity Namespace]:
            prefix: [prefix]
            save: false
            message: true
            message_class: [Message Class Namespace]    #required only if message equal true
        [Entity Namespace]:
            prefix: [prefix]
            save: true
            save_method: getId     #optional (default getId)
            message: false

Update

Run de following composer command:

composer update experteam/api-redis-bundle

License

MIT license.