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/deep_dup.rb,
lib/mudis-ql/metrics_scope.rb

Overview

MudisQL provides a simple query DSL for mudis cache

Defined Under Namespace

Modules: DeepDup Classes: Configuration, Error, MetricsScope, Scope, Store

Constant Summary

VERSION =

'0.2.1'

Class Method Summary

• .configuration ⇒ Configuration

  Get the current configuration.

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

  Configure MudisQL defaults.

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

  Create a new scope for the given namespace.

• .metrics ⇒ MudisQL::MetricsScope

  Access mudis metrics with queryable interface.

Class Method Details

.configuration ⇒ Configuration

Get the current configuration

Returns:

• (Configuration) —

  current configuration

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

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

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

Configure MudisQL defaults

Yields:

• (Configuration) —

  configuration object

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

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:

• (MudisQL::Scope) —

  a new scope object

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

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

.metrics ⇒ MudisQL::MetricsScope

Access mudis metrics with queryable interface

Returns:

• (MudisQL::MetricsScope) —

  a metrics scope object

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

def self.metrics
  MetricsScope.new
end