Giter Club home page Giter Club logo

redis-tile-store's Introduction

redis-tile-store

A module to extend express-tile-cache memory cache to use Redis.

Overview

redis-tile-store is based on the conception of TJ's connect-redis and provides redis store functionality to a tile source in express-tile-cache

var redisTileStore = require("redis-tile-store");

It also supports key pairs expiring, disabled by default. Invoke setTtl(###) to enable.

Installation

npm install redis-tile-store --save

Usage

Create a new instance of the storage object with S3 configuration and assign it to a tile source configuration:

var express = require("express"),
  tilecache = require("express-tile-cache"),
  redisTileStore = require("redis-tile-store"),
  app = express();

var redisStore = redisTileStore({
  port: 6379,
  host: "redis-url-here",
  prefix: "tiles" //should you need one
})
var argenmaptiles = {
  urlTemplate: "http://wms.ign.gob.ar/geoserver/gwc/service/tms/1.0.0",
  store: redisStore
}

app.use(tilecache(argenmaptiles));

Options

  • ttl {Number}: optional - seconds to keep cache valid for each tile. Defaults to 10 days (864000 seconds)
  • port
  • host
  • prefix

API

Module

The redis-tile-store module returns a function.

var redisTileStore = require("redis-tile-store");

redis-tile-store.set(hash, data, callback)

Arguments

  • hash - {String} Required: Identifier string for the tile to store

  • data - {Object} Required: related dataset of the tile.

  • callback - {Function}

redis-tile-store.get(hash, callback)

Arguments

  • hash - {String} Required: Identifier string for the tile to store

  • callback - {Function} Required {Function}. This function will bring back the properties reported by S3 after uploading the file:

redis-tile-store.setTtl(minutes)

Enables TTL and sets expiring time. Calling this method enables TTL usage, off by default.

  • minutes {Number}: minutes the key pair kept alive

Changelog

1.2.0

  • Bugfixing
  • TTL now in seconds

1.1.1

  • Added setTtl method for setting and enabling key pairs expiring

1.1.0-beta

  • Use of SETEX command, setting TTL enables key pairs expire

#License

The MIT License (MIT)

Copyright (c) 2015 Christian Gastrell <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

redis-tile-store's People

Contributors

cgastrell avatar

Stargazers

 avatar Thomas Gratier avatar

Watchers

 avatar James Cloos avatar

Forkers

cuulee

redis-tile-store's Issues

improve examples in docs

more situations/alternatives. Deal with redis setup obstacles, dig for free options, state the downside/uselessness of an outside/slow redis (beats the purpose of the cache speed, remains a cool cache)

clear'em all

Find an effective way of clearing the whole cache. Good example of why you should set your prefix for some tiles.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.