Skip to content

davidcoallier/rds-json-nginx-module

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Name
    ngx_rds_json - an output filter that formats Resty
        DBD Streams generated by ngx_drizzle and others to JSON

Status
    This module is considered production ready.

    We need your help! If you find this module useful and/or
    interesting, please consider joining the development!
    Commit bit can be freely delivered at your request ;)

Synopsis

   server {
        location /mysql {
            drizzle_query 'select * from cats';
            drizzle_pass my_mysql_upstream;

            rds_json on;
        }

        location /foo {
            if ($arg_limit !~ '^\d{2}$') {
                rds_json_ret 400 'Bad "limit" argument';
            }

            drizzle_query "select * from dogs limit $arg_limit";
            drizzle_pass my_mysql_upstream;

            rds_json on;
        }
        ...
    }

Description
    This module provides an output filter that can format the RDS outputs
    generated by ngx_drizzle and ngx_postgres modules.

Installation
    Grab the nginx source code from nginx.net (<http://nginx.net/>), for
    example, the version 0.8.36 (see nginx compatibility), and then build
    the source with this module:

        $ wget 'http://sysoev.ru/nginx/nginx-0.8.36.tar.gz'
        $ tar -xzvf nginx-0.8.36.tar.gz
        $ cd nginx-0.8.36/

        # Here we assume you would install you nginx under /opt/nginx/.
        $ ./configure --prefix=/opt/nginx \
            --add-module=/path/to/drizzle-nginx-module
            --add-module=/path/to/rds-json-nginx-module

        $ make -j2
        $ make install

    Download the latest version of the release tarball of this module from
    rds-json-nginx-module file list
    (<http://github.com/agentzh/rds-json-nginx-module/downloads>).

Compatibility
    The following versions of Nginx should work with this module:

    *   0.8.x (last tested version is 0.8.40)

    *   0.7.x >= 0.7.46 (last tested version is 0.7.66)

    Earlier versions of Nginx like 0.6.x and 0.5.x will *not* work.

    If you find that any particular version of Nginx above 0.7.44 does not
    work with this module, please consider reporting a bug.

TODO

Known Issues

See Also

    * ngx_drizzle ( http://github.com/chaoslawful/drizzle-nginx-module )

    * ngx_postgres ( http://github.com/FRiCKLE/ngx_postgres/ )

Author
    agentzh (章亦春) <agentzh at gmail dot com>

Copyright & License
    This module is licenced under the BSD license.

    Copyright (c) 2009-2010, Taobao Inc., Alibaba Group ( http://www.taobao.com ).

    Copyright (C) 2009-2010, Yichun Zhang (agentzh) <agentzh@gmail.com>.

    All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:

        * Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.

        * Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.

        * Neither the name of the Taobao Inc. nor the names of its
        contributors may be used to endorse or promote products derived from
        this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
    TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

About

An nginx output filter that formats Resty DBD Streams generated by ngx_drizzle and others to JSON

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Perl 81.0%
  • C 18.4%
  • Shell 0.6%