Getting Started
이 플러그인의 설치 단계와 전체 마크다운 가이드를 포함한 설정 지시서를 복사하세요.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-data-storage-sqlite`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/data-storage-sqlite/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
설치
설치bun add @capgo/capacitor-data-storage-sqlitebunx cap syncimport
importimport { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';API Overview
API 개요openStore
__CAPGO_KEEP_0__ 개요__CAPGO_KEEP_0__ 개요
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.openStore({} as capOpenStorageOptions);closeStore
__CAPGO_KEEP_0__ 개요__CAPGO_KEEP_0__ 개요
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.closeStore({} as capStorageOptions);isStoreOpen
__CAPGO_KEEP_0__ 개요__CAPGO_KEEP_0__ 개요
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.isStoreOpen({} as capStorageOptions);isStoreExists
__CAPGO_KEEP_0__ 개요__CAPGO_KEEP_0__ 개요
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.isStoreExists({} as capStorageOptions);deleteStore
__CAPGO_KEEP_1____CAPGO_KEEP_2__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.deleteStore({} as capOpenStorageOptions);setTable
__CAPGO_KEEP_3____CAPGO_KEEP_4__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.setTable({} as capTableStorageOptions);__CAPGO_KEEP_6__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.set({} as capDataStorageOptions);__CAPGO_KEEP_8__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.get({} as capDataStorageOptions);remove
제목 '삭제'지정된 키로 데이터 삭제
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.remove({} as capDataStorageOptions);clear
제목 '초기화'데이터 저장소 초기화 (모든 키 삭제)
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.clear();iskey
제목 '키 존재 확인'데이터 키 존재 여부 확인
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.iskey({} as capDataStorageOptions);keys
제목 '키 목록'데이터 키 목록 가져오기
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.keys();values
__CAPGO_KEEP_1____CAPGO_KEEP_2__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.values();filtervalues
__CAPGO_KEEP_1____CAPGO_KEEP_3__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.filtervalues({} as capFilterStorageOptions);keysvalues
__CAPGO_KEEP_4____CAPGO_KEEP_0__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.keysvalues();isTable
__CAPGO_KEEP_0____CAPGO_KEEP_6__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.isTable({} as capTableStorageOptions);tables
__CAPGO_KEEP_1____CAPGO_KEEP_2__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.tables();deleteTable
__CAPGO_KEEP_1____CAPGO_KEEP_3__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.deleteTable({} as capTableStorageOptions);importFromJson
__CAPGO_KEEP_1____CAPGO_KEEP_4__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.importFromJson({} as capStoreImportOptions);isJsonValid
__CAPGO_KEEP_5____CAPGO_KEEP_0__
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.isJsonValid({} as capStoreImportOptions);exportToJson
exportToJsonJSON 객체로 주어진 데이터베이스를 내보세요.
import { CapgoCapacitorDataStorageSqlite } from '@capgo/capacitor-data-storage-sqlite';
await CapgoCapacitorDataStorageSqlite.exportToJson();타입 참조
타입 참조capOpenStorageOptions
capOpenStorageOptionsexport interface capOpenStorageOptions { /** * The storage database name */ database?: string; // default: // ios, android: storageSQLite // web : storageIDB /** * The storage table name */ table?: string; // default: // ios, android: storage_table // web: storage_store /** * Set to true for database encryption */ encrypted?: boolean; // only for ios and android /*** * Set the mode for database encryption * ["encryption", "secret","newsecret"] */ mode?: string; // only for ios and android}capStorageOptions
capStorageOptionsexport interface capStorageOptions { /** * The storage name */ database: string;}capDataStorageResult
capDataStorageResultexport interface capDataStorageResult { /** * result set to true when successful else false */ result?: boolean; /** * a returned message */ message?: string;}capTableStorageOptions
capTableStorageOptionsexport interface capTableStorageOptions { /** * The storage table name */ table: string;}capDataStorageOptions
capDataStorageOptionsexport interface capDataStorageOptions { /** * The data name */ key: string; /** * The data value when required */ value?: string;}capValueResult
capValueResultexport interface capValueResult { /** * the data value for a given data key */ value: string;}capKeysResult
capKeysResultexport interface capKeysResult { /** * the data key list as an Array */ keys: string[];}capValuesResult
capValuesResultexport interface capValuesResult { /** * the data values list as an Array */ values: string[];}capFilterStorageOptions
capFilterStorageOptionsexport interface capFilterStorageOptions { /** * The filter data for filtering keys * * ['%filter', 'filter', 'filter%'] for * [starts with filter, contains filter, ends with filter] */ filter: string;}capKeysValuesResult
capKeysValuesResult 섹션 제목export interface capKeysValuesResult { /** * the data keys/values list as an Array of {key:string,value:string} */ keysvalues: any[];}capTablesResult
capTablesResult 섹션 제목export interface capTablesResult { /** * the tables list as an Array */ tables: string[];}capStoreImportOptions
capStoreImportOptions 섹션 제목export interface capStoreImportOptions { /** * Set the JSON object to import * */ jsonstring?: string;}실질적인 원천
실질적인 원천 섹션 제목이 페이지는 플러그인의 src/definitions.tsAPI의 upstream에서 pubic 변경 시 다시 싱크를 실행하세요.
Getting Started에서 계속
Keep going from Getting Started 섹션 제목만약에 Getting Started storage와 파일 처리를 계획하고 싶다면 @capgo/capacitor-data-storage-sqlite @capgo/capacitor-data-storage-sqlite @capgo/capacitor-data-storage-sqlite @capgo/capacitor-file @capgo/capacitor-file @capgo/capacitor-file @capgo/capacitor-file @capgo/capacitor-uploader @capgo/capacitor-uploader @capgo/capacitor-업로더에 대한 구현 세부 사항에 대해.