SQL - Extended  1.0.0
Pi-Con: Small utilities makes the difference
Public Member Functions | Properties | List of all members
SQLite.SQLiteConnectionString Class Reference

Represents a parsed connection string. More...

Public Member Functions

 SQLiteConnectionString (string databasePath, bool storeDateTimeAsTicks=true)
 Constructs a new SQLiteConnectionString with all the data needed to open an SQLiteConnection. More...
 
 SQLiteConnectionString (string databasePath, bool storeDateTimeAsTicks, object key=null, Action< SQLiteConnection > preKeyAction=null, Action< SQLiteConnection > postKeyAction=null, string vfsName=null)
 Constructs a new SQLiteConnectionString with all the data needed to open an SQLiteConnection. More...
 
 SQLiteConnectionString (string databasePath, SQLiteOpenFlags openFlags, bool storeDateTimeAsTicks, object key=null, Action< SQLiteConnection > preKeyAction=null, Action< SQLiteConnection > postKeyAction=null, string vfsName=null, string dateTimeStringFormat=DateTimeSqliteDefaultFormat, bool storeTimeSpanAsTicks=true)
 Constructs a new SQLiteConnectionString with all the data needed to open an SQLiteConnection. More...
 

Properties

string UniqueKey [get]
 Readonly, set by a constructor of the SQLConnectionString The unique encryption key More...
 
string DatabasePath [get]
 Readonly, set by a constructor of the SQLConnection the Path to the SQLIte-Net Database More...
 
bool StoreDateTimeAsTicks [get]
 
bool StoreTimeSpanAsTicks [get]
 
string DateTimeStringFormat [get]
 
Readonly, set by a constructor of the SQLConnection the date and time format, as stored on the database More...
 
System.Globalization.DateTimeStyles DateTimeStyle [get]
 
Readonly, set by a constructor of the SQLConnection the date and time style, of the local system More...
 
object Key [get]
 Readonly, set by a constructor of the SQLConnection the encryption key to use on the database More...
 
SQLiteOpenFlags OpenFlags [get]
 
Readonly, set by a constructor of the SQLConnection Flags we use to open the connection More...
 
Action< SQLiteConnectionPreKeyAction [get]
 Readonly, set by a constructor of the SQLConnection
Action prior the setting the key for SQLCipher databases More...
 
Action< SQLiteConnectionPostKeyAction [get]
 Readonly, set by a constructor of the SQLConnection
Action after setting the key for SQLCipher databases More...
 
string VfsName [get]
 Readonly, set by a constructor of the SQLConnection the Virtual File System to use on the database. More...
 

Detailed Description

Represents a parsed connection string.

Constructor & Destructor Documentation

◆ SQLiteConnectionString() [1/3]

SQLite.SQLiteConnectionString.SQLiteConnectionString ( string  databasePath,
bool  storeDateTimeAsTicks = true 
)

Constructs a new SQLiteConnectionString with all the data needed to open an SQLiteConnection.

Parameters
databasePathSpecifies the path to the database file.
storeDateTimeAsTicksSpecifies whether to store DateTime properties as ticks (true) or strings (false). You absolutely do want to store them as Ticks in all new projects. The value of false is only here for backwards compatibility. There is a significant speed advantage, with no down sides, when setting storeDateTimeAsTicks = true. If you use DateTimeOffset properties, it will be always stored as ticks regardingless the storeDateTimeAsTicks parameter.

◆ SQLiteConnectionString() [2/3]

SQLite.SQLiteConnectionString.SQLiteConnectionString ( string  databasePath,
bool  storeDateTimeAsTicks,
object  key = null,
Action< SQLiteConnection preKeyAction = null,
Action< SQLiteConnection postKeyAction = null,
string  vfsName = null 
)

Constructs a new SQLiteConnectionString with all the data needed to open an SQLiteConnection.

Parameters
databasePathSpecifies the path to the database file.
storeDateTimeAsTicksSpecifies whether to store DateTime properties as ticks (true) or strings (false). You absolutely do want to store them as Ticks in all new projects. The value of false is only here for backwards compatibility. There is a significant speed advantage, with no down sides, when setting storeDateTimeAsTicks = true. If you use DateTimeOffset properties, it will be always stored as ticks regardingless the storeDateTimeAsTicks parameter.
keySpecifies the encryption key to use on the database. Should be a string or a byte[].
preKeyActionExecutes prior to setting key for SQLCipher databases
postKeyActionExecutes after setting key for SQLCipher databases
vfsNameSpecifies the Virtual File System to use on the database.

◆ SQLiteConnectionString() [3/3]

SQLite.SQLiteConnectionString.SQLiteConnectionString ( string  databasePath,
SQLiteOpenFlags  openFlags,
bool  storeDateTimeAsTicks,
object  key = null,
Action< SQLiteConnection preKeyAction = null,
Action< SQLiteConnection postKeyAction = null,
string  vfsName = null,
string  dateTimeStringFormat = DateTimeSqliteDefaultFormat,
bool  storeTimeSpanAsTicks = true 
)

Constructs a new SQLiteConnectionString with all the data needed to open an SQLiteConnection.

Parameters
databasePathSpecifies the path to the database file.
openFlagsFlags controlling how the connection should be opened.
storeDateTimeAsTicksSpecifies whether to store DateTime properties as ticks (true) or strings (false). You absolutely do want to store them as Ticks in all new projects. The value of false is only here for backwards compatibility. There is a significant speed advantage, with no down sides, when setting storeDateTimeAsTicks = true. If you use DateTimeOffset properties, it will be always stored as ticks regardingless the storeDateTimeAsTicks parameter.
keySpecifies the encryption key to use on the database. Should be a string or a byte[].
preKeyActionExecutes prior to setting key for SQLCipher databases
postKeyActionExecutes after setting key for SQLCipher databases
vfsNameSpecifies the Virtual File System to use on the database.
dateTimeStringFormatSpecifies the format to use when storing DateTime properties as strings.
storeTimeSpanAsTicksSpecifies whether to store TimeSpan properties as ticks (true) or strings (false). You absolutely do want to store them as Ticks in all new projects. The value of false is only here for backwards compatibility. There is a significant speed advantage, with no down sides, when setting storeTimeSpanAsTicks = true.

Property Documentation

◆ DatabasePath

string SQLite.SQLiteConnectionString.DatabasePath
get

Readonly, set by a constructor of the SQLConnection the Path to the SQLIte-Net Database

◆ DateTimeStringFormat

string SQLite.SQLiteConnectionString.DateTimeStringFormat
get


Readonly, set by a constructor of the SQLConnection the date and time format, as stored on the database

◆ DateTimeStyle

System.Globalization.DateTimeStyles SQLite.SQLiteConnectionString.DateTimeStyle
get


Readonly, set by a constructor of the SQLConnection the date and time style, of the local system

◆ Key

object SQLite.SQLiteConnectionString.Key
get

Readonly, set by a constructor of the SQLConnection the encryption key to use on the database

◆ OpenFlags

SQLiteOpenFlags SQLite.SQLiteConnectionString.OpenFlags
get


Readonly, set by a constructor of the SQLConnection Flags we use to open the connection

◆ PostKeyAction

Action<SQLiteConnection> SQLite.SQLiteConnectionString.PostKeyAction
get

Readonly, set by a constructor of the SQLConnection
Action after setting the key for SQLCipher databases

◆ PreKeyAction

Action<SQLiteConnection> SQLite.SQLiteConnectionString.PreKeyAction
get

Readonly, set by a constructor of the SQLConnection
Action prior the setting the key for SQLCipher databases

◆ StoreDateTimeAsTicks

bool SQLite.SQLiteConnectionString.StoreDateTimeAsTicks
get

<summary Readonly, set by a constructor of the SQLConnection
the date and time as Ticks, stored on the database

◆ StoreTimeSpanAsTicks

bool SQLite.SQLiteConnectionString.StoreTimeSpanAsTicks
get

Readonly, set by a constructor of the SQLConnection the date and time as Ticks, as stored on the database

◆ UniqueKey

string SQLite.SQLiteConnectionString.UniqueKey
get

Readonly, set by a constructor of the SQLConnectionString The unique encryption key

◆ VfsName

string SQLite.SQLiteConnectionString.VfsName
get

Readonly, set by a constructor of the SQLConnection the Virtual File System to use on the database.


The documentation for this class was generated from the following file: