시작하기
이 플러그인의 설치 단계와 전체 마크다운 가이드를 포함한 설정 명령어를 복사하세요.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-fast-sql`
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/fast-sql/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.
설치
설치 섹션Capgo의 AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 스킬을 추가하려면 다음 명령어를 사용하세요:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins다음 명령어를 사용하세요:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-fast-sql` plugin in my project.만약 Manual Setup을 선호한다면, 다음 명령어를 실행하고 아래의 플랫폼별 지침을 따르세요:
bun add @capgo/capacitor-fast-sqlbunx cap syncImport
Import 섹션import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';API 개요
API 개요 섹션connect
Section titled “연결”데이터베이스 연결을 초기화하고 HTTP 서버를 시작하세요.
import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';
const conn = await CapgoCapacitorFastSql.connect({ database: 'myapp' });console.log('Connected on port:', conn.port);disconnect
Section titled “해제”데이터베이스 연결을 종료하고 HTTP 서버를 중지하세요.
import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';
await CapgoCapacitorFastSql.disconnect({ database: 'myapp' });getServerInfo
Section titled “서버 정보”직접 통신을 위한 HTTP 서버 포트와 토큰을 가져오세요.
import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';
const info = await CapgoCapacitorFastSql.getServerInfo({ database: 'myapp' });console.log('Server port:', info.port);execute
Section titled “실행”SQL 쿼리를 실행하기 위해 Capacitor 브릿지를 사용하세요 (단순 쿼리용). 대량 데이터셋을 처리하기 위해 더 좋은 성능을 원하신다면, HTTP 프로토콜을 직접 사용하세요.
import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';
const result = await CapgoCapacitorFastSql.execute({ database: 'myapp', statement: 'SELECT * FROM users WHERE age > ?', params: [18]});console.log('Rows:', result.rows);beginTransaction
beginTransaction데이터베이스 트랜잭션을 시작합니다.
import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';
await CapgoCapacitorFastSql.beginTransaction({ database: 'myapp' });// Execute multiple operationsawait CapgoCapacitorFastSql.commitTransaction({ database: 'myapp' });commitTransaction
commitTransaction현재 트랜잭션을 커밋합니다.
import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';
await CapgoCapacitorFastSql.commitTransaction({ database: 'myapp' });rollbackTransaction
rollbackTransaction현재 트랜잭션을 롤백합니다.
import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';
try { await CapgoCapacitorFastSql.beginTransaction({ database: 'myapp' }); // Operations... await CapgoCapacitorFastSql.commitTransaction({ database: 'myapp' });} catch (error) { await CapgoCapacitorFastSql.rollbackTransaction({ database: 'myapp' });}configureWeb
configureWebsql.js WASM 모듈의 웹 관련 옵션을 구성합니다.
이 함수를 호출합니다. 기존 기능 개발하기 전에 기존 기능 개발하기 전에 connect() 로컬로 패키지된 경로에서 sql.js를 로드하는 첫 번째 호출 대신 기본 CDN을 사용하는 대신에 이 메서드는 iOS 및 Android에서 비어있는 메서드입니다.
import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';
// Configure once at app startup (web only)await CapgoCapacitorFastSql.configureWeb({ sqlJsUrl: '/assets/sql-wasm.js', wasmUrl: '/assets/sql-wasm.wasm',});const db = await FastSQL.connect({ database: 'myapp' });타입 참조
타입 참조SQLConnectionOptions
데이터베이스 연결 옵션타입 참조
export interface SQLConnectionOptions { /** * Database name (file will be created in app data directory) */ database: string;
/** * Enable encryption (iOS/Android only) */ encrypted?: boolean;
/** * Encryption key (required if encrypted is true) */ encryptionKey?: string;
/** * Read-only mode */ readOnly?: boolean;}SQLValue
SQL 플러그인에서 지원하는 SQL 값 타입SQLValue
export type SQLValue = string | number | boolean | null | Uint8Array;SQLResult
SQLResultSQL 쿼리 실행 결과
export interface SQLResult { /** * Rows returned by the query (for SELECT statements) */ rows: SQLRow[];
/** * Number of rows affected by the query (for INSERT/UPDATE/DELETE) */ rowsAffected: number;
/** * ID of the last inserted row (for INSERT statements with auto-increment) */ insertId?: number;}IsolationLevel
격리 수준격리 수준
export enum IsolationLevel { ReadUncommitted = 'READ UNCOMMITTED', ReadCommitted = 'READ COMMITTED', RepeatableRead = 'REPEATABLE READ', Serializable = 'SERIALIZABLE',}WebConfig
웹 플랫폼 구성sql.js WASM 모듈의 웹 플랫폼 구성. 이 옵션을 사용하여 sql.js를 로컬로 패키징된 경로에서 로드할 수 있습니다. 기본 CDN 대신. configureWeb() SQLRow
export interface WebConfig { /** * URL to the sql.js JavaScript file (`sql-wasm.js`). * When omitted, the plugin loads from the cdnjs CDN. * @example '/assets/sql-wasm.js' */ sqlJsUrl?: string;
/** * URL to the sql.js WebAssembly binary (`sql-wasm.wasm`). * When omitted, the plugin loads from the cdnjs CDN. * @example '/assets/sql-wasm.wasm' */ wasmUrl?: string;}SQLRow
SQLRowSQL 쿼리 결과 - 열 이름에 색인된 값
export interface SQLRow { [column: string]: SQLValue;}실질적인 진실
실질적인 진실이 페이지는 플러그인의 src/definitions.ts공개 API이 업스트림에서 변경될 때 다시 싱크를 실행하세요.
시작하기
시작하기이 플러그인을 사용하여 대시보드와 __CAPGO_KEEP_0__를 계획하고 운영하고 싶다면 Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-fast-sql Using @API/__CAPGO_KEEP_1__-fast-sql 이 플러그인을 사용하여 네이티브 기능인 Using @capgo/capacitor-fast-sql을 사용하세요. native 기능을 사용하는 @capgo/capacitor-fast-sql에 대한 지원 API 개요 API 구현 세부 정보를 위한 소개 소개 구현 세부 정보를 위한 API 키 API 키 구현 세부 정보를 위한, 그리고 장치 __CAPGO_KEEP_0__ 구현 세부 정보를 위한 장치.