firebase-admin.firestore package

외부 API 다시 내보내기

편의를 위해 다음과 같은 외부에서 정의된 API를 이 모듈 진입점에서 다시 내보냅니다.

기호 설명
대량 작성자 @google-cloud/firestore 패키지의 BulkWriter 유형
AggregateField @google-cloud/firestore 패키지의 AggregateField 유형
BulkWriterOptions @google-cloud/firestore 패키지의 BulkWriterOptions 유형
BundleBuilder @google-cloud/firestore 패키지의 BundleBuilder 유형
CollectionGroup @google-cloud/firestore 패키지의 CollectionGroup 유형
CollectionReference @google-cloud/firestore 패키지의 CollectionReference 유형
문서 변경 @google-cloud/firestore 패키지의 DocumentChange 유형
문서 데이터 @google-cloud/firestore 패키지의 DocumentData 유형
DocumentReference @google-cloud/firestore 패키지의 DocumentReference 유형
DocumentSnapshot @google-cloud/firestore 패키지의 DocumentSnapshot 유형
FieldPath @google-cloud/firestore 패키지의 FieldPath 유형
필드 값 @google-cloud/firestore 패키지의 FieldValue 유형
필터 @google-cloud/firestore 패키지의 Filter 유형
Firestore @google-cloud/firestore 패키지의 Firestore 유형
FirestoreDataConverter @google-cloud/firestore 패키지의 FirestoreDataConverter 유형
GeoPoint @google-cloud/firestore 패키지의 GeoPoint 유형
GrpcStatus @google-cloud/firestore 패키지의 GrpcStatus 유형
전제 조건 @google-cloud/firestore 패키지의 Precondition 유형
쿼리 @google-cloud/firestore 패키지의 Query 유형
QueryDocumentSnapshot @google-cloud/firestore 패키지의 QueryDocumentSnapshot 유형
쿼리 파티션 @google-cloud/firestore 패키지의 QueryPartition 유형
QuerySnapshot @google-cloud/firestore 패키지의 QuerySnapshot 유형
ReadOptions @google-cloud/firestore 패키지의 ReadOptions 유형
SetOptions @google-cloud/firestore 패키지의 SetOptions 유형
타임스탬프 @google-cloud/firestore 패키지의 Timestamp 유형
트랜잭션 @google-cloud/firestore 패키지의 Transaction 유형
WriteBatch @google-cloud/firestore 패키지의 WriteBatch 유형
WriteResult @google-cloud/firestore 패키지의 WriteResult 유형
setLogFunction @google-cloud/firestore 패키지의 setLogFunction 함수입니다.

Cloud Firestore로 이동합니다

함수

함수 설명
getFirestore()를 사용합니다. 기본 앱의 기본 Firestore 서비스를 가져옵니다.
getFirestore(app) 지정된 앱의 기본 Firestore 서비스를 가져옵니다.
getFirestore(databaseId) (베타) 기본 앱에 사용할 이름이 지정된 Firestore 서비스를 가져옵니다.
getFirestore(app, databaseId) (베타) 지정된 앱에 대해 이름이 지정된 Firestore 서비스를 가져옵니다.
초기화(앱, 설정) 지정된 앱의 기본 Firestore 서비스를 가져오고 추가 매개변수를 생성자에 전달합니다.
initialFirestore(app, settings, databaseId) (베타) 지정된 앱에 대해 이름이 지정된 Firestore 서비스를 가져와 추가 매개변수를 생성자에 전달합니다.

클래스

클래스 설명
FirebaseFirestoreError Firebase Firestore 오류 코드 구조 이렇게 하면 FirebaseError가 확장됩니다.

인터페이스

인터페이스 설명
Firestore 설정 Firestore 생성자에 전달할 설정입니다.

Firestore getFirestore()

기본 앱의 기본 Firestore 서비스를 가져옵니다.

서명:

export declare function getFirestore(): Firestore;

반환:

Firestore

기본 앱의 기본 Firestore 서비스

예

// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();

getFirestore(앱)

지정된 앱의 기본 Firestore 서비스를 가져옵니다.

서명:

export declare function getFirestore(app: App): Firestore;

매개변수

매개변수 유형 설명
앱 앱 반환할 Firestore 서비스를 지정합니다.

반환:

Firestore

제공된 앱과 연결된 기본 Firestore 서비스입니다.

예

// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);

getFirestore(databaseId)

이 API는 개발자를 위한 미리보기로 제공되며 Google에 접수된 의견에 따라 변경될 수 있습니다. 프로덕션 환경에서는 이 API를 사용하지 마세요.

기본 앱에 대해 이름이 지정된 Firestore 서비스를 가져옵니다.

서명:

export declare function getFirestore(databaseId: string): Firestore;

매개변수

매개변수 유형 설명
데이터베이스 ID 문자열 반환할 데이터베이스의 이름입니다.

반환:

Firestore

기본 앱을 위한, 이름이 지정된 Firestore 서비스

예

// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');

getFirestore(app, databaseId)

이 API는 개발자를 위한 미리보기로 제공되며 Google에 접수된 의견에 따라 변경될 수 있습니다. 프로덕션 환경에서는 이 API를 사용하지 마세요.

지정된 앱의 이름이 지정된 Firestore 서비스를 가져옵니다.

서명:

export declare function getFirestore(app: App, databaseId: string): Firestore;

매개변수

매개변수 유형 설명
앱 앱 반환할 Firestore 서비스를 지정합니다.
데이터베이스 ID 문자열 반환할 데이터베이스의 이름입니다.

반환:

Firestore

제공된 앱과 연결된 이름이 지정된 Firestore 서비스

예

// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');

Firestore(앱, 설정)

지정된 앱의 기본 Firestore 서비스를 가져오고 추가 매개변수를 생성자에 전달합니다.

서명:

export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;

매개변수

매개변수 유형 설명
앱 앱 반환할 Firestore 서비스를 지정합니다.
설정 Firestore 설정 생성자에 전달할 설정 객체입니다.

반환:

Firestore

제공된 앱 및 설정과 연결된 기본 Firestore 서비스입니다.

예

// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});

Firestore(앱, 설정, 데이터베이스 ID)

이 API는 개발자를 위한 미리보기로 제공되며 Google에 접수된 의견에 따라 변경될 수 있습니다. 프로덕션 환경에서는 이 API를 사용하지 마세요.

지정된 앱의 이름이 지정된 Firestore 서비스를 가져오고 추가 매개변수를 생성자에 전달합니다.

서명:

export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;

매개변수

매개변수 유형 설명
앱 앱 반환할 Firestore 서비스를 지정합니다.
설정 Firestore 설정 생성자에 전달할 설정 객체입니다.
데이터베이스 ID 문자열 반환할 데이터베이스의 이름입니다.

반환:

Firestore

제공된 앱 및 설정과 연결된 이름이 지정된 Firestore 서비스입니다.

예

// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');