Module: MudisQL

Defined in:
lib/mudis-ql.rb,
lib/mudis-ql/scope.rb,
lib/mudis-ql/store.rb,
lib/mudis-ql/version.rb,
lib/mudis-ql/metrics_scope.rb

Overview

MudisQL provides a simple query DSL for mudis cache

Defined Under Namespace

Classes: Configuration, Error, MetricsScope, Scope, Store

Constant Summary collapse

VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Configuration

Get the current configuration

Returns:



37
38
39
 
# File 'lib/mudis-ql.rb', line 37

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|Configuration| ... } ⇒ Object

Configure MudisQL defaults

Yields:



30
31
32
 
# File 'lib/mudis-ql.rb', line 30

def self.configure
  yield configuration
end

.from(namespace = nil) ⇒ MudisQL::Scope

Create a new scope for the given namespace

Parameters:

  • namespace (String, nil) (defaults to: nil) —

    the mudis namespace to query (nil for default/no namespace)

Returns:



16
17
18
 
# File 'lib/mudis-ql.rb', line 16

def self.from(namespace = nil)
  Scope.new(Store.new(namespace))
end

.metrics ⇒ MudisQL::MetricsScope

Access mudis metrics with queryable interface

Returns:



23
24
25
 
# File 'lib/mudis-ql.rb', line 23

def self.metrics
  MetricsScope.new
end