GRDB Docs (89% documented)

Install in Dash

GRDB Reference DatabaseValue Struct Reference

DatabaseValue

public struct DatabaseValue

DatabaseValue is the intermediate type between SQLite and your values.

See https://www.sqlite.org/datatype3.html

Storage
An SQLite storage (NULL, INTEGER, REAL, TEXT, BLOB).
See more
Declaration
Swift

public enum Storage
Show on GitHub
storage
The SQLite storage
Declaration
Swift

public let storage: Storage
Show on GitHub


                    
                    
                    null

The NULL DatabaseValue.

Declaration

Swift

public static let null = DatabaseValue(storage: .null)

Show on GitHub

init(value:)
Creates a DatabaseValue from Any.

The result is nil unless object adopts DatabaseValueConvertible.
Declaration
Swift

public init?(value: Any)
Show on GitHub

Extracting Value

isNull
Returns true if databaseValue is NULL.
Declaration
Swift

public var isNull: Bool
Show on GitHub
value()
Returns Int64, Double, String, Data or nil.
Declaration
Swift

public func value() -> DatabaseValueConvertible?
Show on GitHub
value()
Returns the value, converted to the requested type.

If the SQLite value is NULL, the result is nil. Otherwise the SQLite value is converted to the requested type Value. Should this conversion fail, a fatal error is raised.

If this fatal error is unacceptable to you, use DatabaseValueConvertible.fromDatabaseValue() method.
Declaration
Swift

public func value<Value: DatabaseValueConvertible>() -> Value?
Return Value

An optional .

Show on GitHub
value()
Returns the value, converted to the requested type.

This method crashes if the SQLite value is NULL, or if the SQLite value can not be converted to Value.
Declaration
Swift

public func value<Value: DatabaseValueConvertible>() -> Value
Return Value

A .

Show on GitHub

hashValue
The hash value
Declaration
Swift

public var hashValue: Int
Show on GitHub
==(_:_:)
Returns whether two DatabaseValues are equal.
```
1.databaseValue == "foo".databaseValue // false
1.databaseValue == 1.databaseValue     // true
```
When comparing integers and doubles, the result is true if and only values are equal, and if converting one type to the other does not lose information:
```
1.databaseValue == 1.0.databaseValue   // true
```
Declaration
Swift

public static func ==(lhs: DatabaseValue, rhs: DatabaseValue) -> Bool
Show on GitHub

databaseValue
Returns self
Declaration
Swift

public var databaseValue: DatabaseValue
Show on GitHub


                    
                    
                    fromDatabaseValue(_:)

Returns databaseValue

Declaration

Swift

public static func fromDatabaseValue(_ databaseValue: DatabaseValue) -> DatabaseValue?

Show on GitHub

sqlExpression
This property is an implementation detail of the query interface. Do not use it directly.

See https://github.com/groue/GRDB.swift/#the-query-interface

Low Level Query Interface

See SQLExpression.sqlExpression
Declaration
Swift

public var sqlExpression: SQLExpression
Show on GitHub

description
A textual representation of self.
Declaration
Swift

public var description: String
Show on GitHub

expressionSQL(_:)
This function is an implementation detail of the query interface. Do not use it directly.

See https://github.com/groue/GRDB.swift/#the-query-interface

Low Level Query Interface

See SQLExpression.expressionSQL(_:arguments:)
Declaration
Swift

public func expressionSQL(_ arguments: inout StatementArguments?) -> String
Show on GitHub
negated
This property is an implementation detail of the query interface. Do not use it directly.

See https://github.com/groue/GRDB.swift/#the-query-interface

Low Level Query Interface

See SQLExpression.negated
Declaration
Swift

public var negated: SQLExpression
Show on GitHub