시작하기

설치

AI 지원 설정으로 플러그인을 설치할 수 있습니다. 다음 명령어로 AI 도구에 Capgo 스킬을 추가하세요:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

그다음 아래 prompt를 사용하세요:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-fast-sql` plugin in my project.

Manual Setup을 선호한다면, 다음 명령어를 실행하여 플러그인을 설치하고 아래의 플랫폼별 지침을 따르세요:

npm install @capgo/capacitor-fast-sql
npx cap sync

가져오기

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

빠른 시작

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

const conn = await CapgoCapacitorFastSql.connect({ database: 'myapp' });
console.log('Connected on port:', conn.port);

예시: 연결 해제

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

await CapgoCapacitorFastSql.disconnect({ database: 'myapp' });

예제: getServerInfo

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

const info = await CapgoCapacitorFastSql.getServerInfo({ database: 'myapp' });
console.log('Server port:', info.port);

자주 하는 실수

• 네이티브 동기화: 실행 npx cap sync 플러그인 업그레이드 후.
• 단일 진실 공급원: 신뢰 src/definitions.ts GitHub 레포지토리에서.

API 개요

connect

데이터베이스 연결을 초기화하고 HTTP 서버를 시작합니다.

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

const conn = await CapgoCapacitorFastSql.connect({ database: 'myapp' });
console.log('Connected on port:', conn.port);

disconnect

데이터베이스 연결을 종료하고 HTTP 서버를 중지합니다.

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

await CapgoCapacitorFastSql.disconnect({ database: 'myapp' });

getServerInfo

직접 통신을 위한 HTTP 서버 포트와 토큰을 가져옵니다.

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

const info = await CapgoCapacitorFastSql.getServerInfo({ database: 'myapp' });
console.log('Server port:', info.port);

execute

Capacitor 브릿지를 통해 SQL 쿼리를 실행합니다 (단순 쿼리용). 대용량 데이터셋의 성능을 높이려면 SQLConnection 클래스를 통해 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

데이터베이스 트랜잭션을 시작합니다.

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

await CapgoCapacitorFastSql.beginTransaction({ database: 'myapp' });
// Execute multiple operations
await CapgoCapacitorFastSql.commitTransaction({ database: 'myapp' });

commitTransaction

현재 트랜잭션을 커밋합니다.

import { CapgoCapacitorFastSql } from '@capgo/capacitor-fast-sql';

await CapgoCapacitorFastSql.commitTransaction({ database: 'myapp' });

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

sql.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 값 타입입니다.

export type SQLValue = string | number | boolean | null | Uint8Array;

SQLResult

SQL 쿼리 실행 결과입니다.

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 모듈을 위한 웹 플랫폼 설정입니다. 다음을 사용하여 활용하세요: configureWeb() 기본 CDN 대신 로컬에 번들링된 경로에서 sql.js를 로드할 수 있습니다.

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

SQL 행 결과 - 컬럼 이름으로 인덱싱된 값

export interface SQLRow {
  [column: string]: SQLValue;
}

기준 소스

이 페이지는 플러그인의 src/definitions.ts에서 생성되었습니다. public API가 업스트림에서 변경되면 동기화를 다시 실행하세요.

Getting Started에서 계속하기

사용 중인 경우 시작하기 대시보드와 API 운영을 계획하려면, 이를 다음 항목과 연결하세요: @capgo/capacitor-fast-sql 사용하기 @capgo/capacitor-fast-sql 사용하기의 네이티브 기능을 위해, API 개요 API Overview의 구현 상세 내용은 소개 Introduction의 구현 상세 내용은 API 키 API Keys의 구현 세부 사항은, 디바이스 Devices의 구현 세부 사항은.