Class: Browser::Database::SQL

Inherits:
Object
  • Object
show all
Includes:
Native::Wrapper
Defined in:
opal/browser/database/sql.rb

Defined Under Namespace

Classes: Error, Result, Row, Transaction

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ SQL

Open a database with the given name and options.

Parameters:

  • name (String) —

    the name for the database

  • options (Hash) (defaults to: {}) —

    options to open the database

Options Hash (options):

  • :description (String) —

    the description for the database

  • :version (String) — default: '' —

    the expected version of the database

  • :size (Integer) — default: 5 * 1024 * 1024 —

    the size constraint in bytes



48
49
50
51
52
53
54
55
 
# File 'opal/browser/database/sql.rb', line 48

def initialize(name, options = {})
  @name        = name
  @description = options[:description] || name
  @version     = options[:version]     || ''
  @size        = options[:size]        || 2 * 1024 * 1024

  super(`window.openDatabase(#{name}, #{@version}, #{@description}, #{@size})`)
end

Instance Attribute Details

#description ⇒ String (readonly)

Returns the description for the database.

Returns:

  • (String) —

    the description for the database



35
36
37
 
# File 'opal/browser/database/sql.rb', line 35

def description
  @description
end

#name ⇒ String (readonly)

Returns the name of the database.

Returns:

  • (String) —

    the name of the database



32
33
34
 
# File 'opal/browser/database/sql.rb', line 32

def name
  @name
end

#size ⇒ Integer (readonly)

Returns the size constraint in bytes.

Returns:

  • (Integer) —

    the size constraint in bytes



38
39
40
 
# File 'opal/browser/database/sql.rb', line 38

def size
  @size
end

Class Method Details

.supported? ⇒ Boolean

Check if the browser supports WebSQL.

Returns:

  • (Boolean) 


7
8
9
 
# File 'opal/browser/database/sql.rb', line 7

def self.supported?
  Browser.supports? 'WebSQL'
end

Instance Method Details

#transaction {|transaction| ... } ⇒ Object

Start a transaction on the database.

Yield Parameters:

  • transaction (Transaction) —

    the transaction to work on

Raises:

  • (ArgumentError) 


81
82
83
84
85
 
# File 'opal/browser/database/sql.rb', line 81

def transaction(&block)
  raise ArgumentError, 'no block given' unless block

  `#@native.transaction(#{->(t) { block.call(Transaction.new(self, t)) }})`
end

#version ⇒ String #version(from, to) {|transaction| ... } ⇒ Object

Overloads:

  • #version ⇒ String

    Get the version of the database.

    Returns:

  • #version(from, to) {|transaction| ... } ⇒ Object

    Migrate the database to a new version.

    Parameters:

    • from (String) —

      the version you're migrating from

    • to (String) —

      the version you're migrating to

    Yield Parameters:

    • transaction (Transaction) —

      the transaction to work with



71
72
73
74
75
76
 
# File 'opal/browser/database/sql.rb', line 71

def version(from = nil, to = nil, &block)
  return `#@native.version` unless block

  `#@native.changeVersion(#{from}, #{to},
    #{->(t) { block.call(Transaction.new(self, t)) }})`
end