liujianchen2013 / rdm-native-value-formatters

Native value formatters for RedisDesktopManager

RedisDesktopManager Native Value Formatters

Advantages:

• Plugin can be developed by any software engineer (Java/C++/C#/Python/PHP/Node.js etc)
• Plugin can be easily debugged

How to implement native value formatter

1. Create directory with meaningful name. Name of the directory will be used as formatter name.
2. Implement script or executable which meets protocol described below.
3. Add file usage.json with usage shell command
   For example for python script it will be: ['python', 'my_super_formatter.py']
4. Test your formatter in RDM!

Protocol

Formatter info:

CMD: <executable> info STDOUT (json):

{
    "version": "1.0.0",
    "description": "Formatter description"
}

Validate:

CMD: <executable> validate STDIN: <binary-data-encoded-with-base64> STDOUT (json):

{    
    “valid”: “false”,    
    “error”: “input is not gziped data” // if valid is false
}

Decode binary data:

CMD: <executable> decode STDIN: <binary-data-encoded-with-base64> STDOUT (json):

{
    “output”: “<decoded data for human-friendly edit>”,
    “read-only”: “false”,    
    “format”: “plain_text” // or “json”
}

Encode string-representation

Required only for formatters which return “read-only”: false in decode method

CMD: <executable> encode STDIN : <edited-string-representation-encoded-with-base64> STDOUT (json):

{
    “output”: “<binary-data-encoded-with-base64>”,    
}

Error handling:

If formatter cannot decode/encode value error response should be returned:

OUT (json):

{
    “error”: “Invalid CBOR data”,    
}