@capacitor-community/sqlite 4.1.0-6 → 4.1.0-8

package/dist/esm/definitions.d.ts

@@ -347,6 +347,10 @@ export interface capConnectionOptions {
      * ["encryption", "secret", "newsecret"]
      */
     mode?: string;
+    /**
+     * Set to true (database in read-only mode) / false
+     */
+    readonly?: boolean;
 }
 export interface capAllConnectionsOptions {
     /**
@@ -360,6 +364,10 @@ export interface capSQLiteOptions {
      * The database name
      */
     database?: string;
+    /**
+     * Set to true (database in read-only mode) / false
+     */
+    readonly?: boolean;
 }
 export interface capNCDatabasePathOptions {
     /**
@@ -402,6 +410,12 @@ export interface capSQLiteExecuteOptions {
      * @since 3.0.0-beta.10
      */
     transaction?: boolean;
+    /**
+     * ReadOnly / ReadWrite
+     * default ReadWrite (false)
+     * @since 4.1.0-7
+     */
+    readonly?: boolean;
 }
 export interface capSQLiteSetOptions {
     /**
@@ -418,6 +432,12 @@ export interface capSQLiteSetOptions {
      * @since 3.0.0-beta.10
      */
     transaction?: boolean;
+    /**
+     * ReadOnly / ReadWrite
+     * default ReadWrite (false)
+     * @since 4.1.0-7
+     */
+    readonly?: boolean;
 }
 export interface capSQLiteRunOptions {
     /**
@@ -438,6 +458,12 @@ export interface capSQLiteRunOptions {
      * @since 3.0.0-beta.10
      */
     transaction?: boolean;
+    /**
+     * ReadOnly / ReadWrite
+     * default ReadWrite (false)
+     * @since 4.1.0-7
+     */
+    readonly?: boolean;
 }
 export interface capSQLiteQueryOptions {
     /**
@@ -454,6 +480,12 @@ export interface capSQLiteQueryOptions {
      * @since 3.0.0-beta.11
      */
     values?: any[];
+    /**
+     * ReadOnly / ReadWrite
+     * default ReadWrite (false)
+     * @since 4.1.0-7
+     */
+    readonly?: boolean;
 }
 export interface capSQLiteImportOptions {
     /**
@@ -473,6 +505,12 @@ export interface capSQLiteExportOptions {
      *
      */
     jsonexportmode?: string;
+    /**
+     * ReadOnly / ReadWrite
+     * default ReadWrite (false)
+     * @since 4.1.0-7
+     */
+    readonly?: boolean;
 }
 export interface capSQLiteFromAssetsOptions {
     /**
@@ -492,6 +530,12 @@ export interface capSQLiteSyncDateOptions {
      * Format yyyy-MM-dd'T'HH:mm:ss.SSSZ
      */
     syncdate?: string;
+    /**
+     * ReadOnly / ReadWrite
+     * default ReadWrite (false)
+     * @since 4.1.0-7
+     */
+    readonly?: boolean;
 }
 export interface capSQLiteSet {
     /**
@@ -536,6 +580,12 @@ export interface capSQLiteTableOptions {
      * The table name
      */
     table?: string;
+    /**
+     * ReadOnly / ReadWrite
+     * default ReadWrite (false)
+     * @since 4.1.0-7
+     */
+    readonly?: boolean;
 }
 export interface capEchoResult {
     /**
@@ -810,24 +860,27 @@ export interface ISQLiteConnection {
      * @param encrypted
      * @param mode
      * @param version
+     * @param readonly
      * @returns Promise<SQLiteDBConnection>
      * @since 2.9.0 refactor
      */
-    createConnection(database: string, encrypted: boolean, mode: string, version: number): Promise<SQLiteDBConnection>;
+    createConnection(database: string, encrypted: boolean, mode: string, version: number, readonly: boolean): Promise<SQLiteDBConnection>;
     /**
      * Check if a connection exists
      * @param database
+     * @param readonly
      * @returns Promise<capSQLiteResult>
      * @since 3.0.0-beta.5
      */
-    isConnection(database: string): Promise<capSQLiteResult>;
+    isConnection(database: string, readonly: boolean): Promise<capSQLiteResult>;
     /**
      * Retrieve an existing database connection
      * @param database
+     * @param readonly
      * @returns Promise<SQLiteDBConnection>
      * @since 2.9.0 refactor
      */
-    retrieveConnection(database: string): Promise<SQLiteDBConnection>;
+    retrieveConnection(database: string, readonly: boolean): Promise<SQLiteDBConnection>;
     /**
      * Retrieve all database connections
      * @returns Promise<Map<string, SQLiteDBConnection>>
@@ -837,10 +890,11 @@ export interface ISQLiteConnection {
     /**
      * Close a database connection
      * @param database
+     * @param readonly
      * @returns Promise<void>
      * @since 2.9.0 refactor
      */
-    closeConnection(database: string): Promise<void>;
+    closeConnection(database: string, readonly: boolean): Promise<void>;
     /**
      * Close all database connections
      * @returns Promise<void>
@@ -979,10 +1033,10 @@ export declare class SQLiteConnection implements ISQLiteConnection {
     changeEncryptionSecret(passphrase: string, oldpassphrase: string): Promise<void>;
     clearEncryptionSecret(): Promise<void>;
     addUpgradeStatement(database: string, toVersion: number, statements: string[]): Promise<void>;
-    createConnection(database: string, encrypted: boolean, mode: string, version: number): Promise<SQLiteDBConnection>;
-    closeConnection(database: string): Promise<void>;
-    isConnection(database: string): Promise<capSQLiteResult>;
-    retrieveConnection(database: string): Promise<SQLiteDBConnection>;
+    createConnection(database: string, encrypted: boolean, mode: string, version: number, readonly: boolean): Promise<SQLiteDBConnection>;
+    closeConnection(database: string, readonly: boolean): Promise<void>;
+    isConnection(database: string, readonly: boolean): Promise<capSQLiteResult>;
+    retrieveConnection(database: string, readonly: boolean): Promise<SQLiteDBConnection>;
     getNCDatabasePath(path: string, database: string): Promise<capNCDatabasePathResult>;
     createNCConnection(databasePath: string, version: number): Promise<SQLiteDBConnection>;
     closeNCConnection(databasePath: string): Promise<void>;
@@ -1012,6 +1066,12 @@ export interface ISQLiteDBConnection {
      * @since 2.9.0 refactor
      */
     getConnectionDBName(): string;
+    /**
+     * Get SQLite DB Connection read-only mode
+     * @returns boolean
+     * @since 4.1.0
+     */
+    getConnectionReadOnly(): boolean;
     /**
      * Open a SQLite DB Connection
      * @returns Promise<void>
@@ -1143,9 +1203,11 @@ export interface ISQLiteDBConnection {
  */
 export declare class SQLiteDBConnection implements ISQLiteDBConnection {
     private dbName;
+    private readonly;
     private sqlite;
-    constructor(dbName: string, sqlite: any);
+    constructor(dbName: string, readonly: boolean, sqlite: any);
     getConnectionDBName(): string;
+    getConnectionReadOnly(): boolean;
     open(): Promise<void>;
     close(): Promise<void>;
     getUrl(): Promise<capSQLiteUrl>;