npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

artillery-engine-sql

v1.0.1

Published

Load test SQL with Artillery.io

Downloads

4

Readme

Artillery.io SQL Plugin

Based on the Lambda Engine by Orchestrated.io.

Usage

Important:

  • The plugin requires Artillery 1.5.8-3 or higher.
  • This plugin uses AnyDB as an underlying method to abstract the DB connectors. You need to install the appropiate connector to your database.

Install the plugin

# If Artillery is installed globally:
npm install -g artillery-engine-sql

Use the plugin

  1. Set the engine property of the scenario to sql.
  2. Set the target to either a string or an object (it's passed directly to AnyDB) as indicated here.
  3. Use query in your scenario to execute the SQL statement. You can pass either a string or an object.

Query as String

You can pass either a SQL Query string to read from. The artillery template will be applied upon it, so statements like 'SELECT * from {{ var }}' are supported.

Query as an Object

When stating the query as an object the parameter 'statement' is required and all the rest are optional. The parameter 'statement' has support for files and also for template statements. The interfaces for 'beforeRequest' and 'afterResponse' are the same as in the HTTP engine, where 'requestParams' is the target configuration and the query itself. You can modify the query dynamically in beforeRequest before it's executed.

- query:
  -
    statement: 'SELECT * from test where id = ?'
    values:
      - 45
    beforeRequest: "before_fn"
    afterResponse: "after_fn"

Example Script

config:
  target: "driver://user:pass@hostname/database"
  phases:
    arrivalCount: 10
    duration: 1
  engines:
    sql: {}

scenarios:
  - name: "SQL query"
    engine: "sql"
    flow:
      - loop:
        - query: 'SELECT * from test'
        - think: 1
        count: 100

(See example.yml for a complete example.)

Example Script with a long SQL Statement

You can use the above approach to read long SQL statements from a file, see the following example snippet:

scenarios:
  - name: "DB Query"
    engine: "sql"
    flow:
      - query:
          beforeRequest: "loadQuery"
          statement: "./query.sql"

In 'query.sql' you would have the SQL statement, as follows:

Select * from test

In your processor file, you would have something like this:

interface UserContext {
    vars: { [k: string]: string | number };
}

interface DBParams {
    query: string;
    args: string[];
    afterResponse: Function;
    beforeRequest: Function;
    target: Object;
}

function loadQuery(params: DBParams, context: UserContext, ee: EventListener, next: (err?: Error) => void) {
    let filePath = params.query;
    if (filePath !== path.basename(filePath)) {
        // the query is a path
        if (!path.isAbsolute(filePath) && !fs.existsSync(filePath)) {
            // it may be relative to us
            filePath = path.resolve(__dirname, filePath);
        }
        if (fs.existsSync(filePath) && fs.lstatSync(filePath).isFile()) {
            params.query = fs.readFileSync(filePath).toString();
        }
    }
    next();
}
module.exports = { loadQuery: loadQuery };

Run Your Script

artillery run my_script.yml

License

MPL 2.0