Skip to content

Commit ac578e9

Browse files
authored
Make index beta (#6510)
* Make index beta * Update API reports * Add missing one. * Update API reports * Fix format Co-authored-by: wu-hui <[email protected]>
1 parent 79df09b commit ac578e9

File tree

2 files changed

+5
-32
lines changed

2 files changed

+5
-32
lines changed

common/api-review/firestore.api.md

-30
Original file line numberDiff line numberDiff line change
@@ -233,30 +233,6 @@ export function getFirestore(app?: FirebaseApp): Firestore;
233233
// @public
234234
export function increment(n: number): FieldValue;
235235

236-
// @public
237-
export interface Index {
238-
// (undocumented)
239-
[key: string]: unknown;
240-
readonly collectionGroup: string;
241-
readonly fields?: IndexField[];
242-
}
243-
244-
// @public
245-
export interface IndexConfiguration {
246-
// (undocumented)
247-
[key: string]: unknown;
248-
readonly indexes?: Index[];
249-
}
250-
251-
// @public
252-
export interface IndexField {
253-
// (undocumented)
254-
[key: string]: unknown;
255-
readonly arrayConfig?: 'CONTAINS';
256-
readonly fieldPath: string;
257-
readonly order?: 'ASCENDING' | 'DESCENDING';
258-
}
259-
260236
// @public
261237
export function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings): Firestore;
262238

@@ -420,12 +396,6 @@ export function setDoc<T>(reference: DocumentReference<T>, data: WithFieldValue<
420396
// @public
421397
export function setDoc<T>(reference: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): Promise<void>;
422398

423-
// @public
424-
export function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
425-
426-
// @public
427-
export function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
428-
429399
// @public
430400
export function setLogLevel(logLevel: LogLevel): void;
431401

packages/firestore/src/api/index_configuration.ts

+5-2
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,9 @@ export {
3535
EmulatorMockTokenOptions
3636
} from '../lite-api/database';
3737

38-
// TODO(indexing): Remove "@internal" from the API.
39-
4038
/**
4139
* A single field element in an index configuration.
40+
* @beta
4241
*/
4342
export interface IndexField {
4443
/** The field path to index. */
@@ -63,6 +62,7 @@ export interface IndexField {
6362

6463
/**
6564
* The SDK definition of a Firestore index.
65+
* @beta
6666
*/
6767
export interface Index {
6868
/** The ID of the collection to index. */
@@ -78,6 +78,7 @@ export interface Index {
7878
*
7979
* See {@link https://firebase.google.com/docs/reference/firestore/indexes/#json_format | JSON Format}
8080
* for a description of the format of the index definition.
81+
* @beta
8182
*/
8283
export interface IndexConfiguration {
8384
/** A list of all Firestore indexes. */
@@ -106,6 +107,7 @@ export interface IndexConfiguration {
106107
* @throws FirestoreError if the JSON format is invalid.
107108
* @returns A `Promise` that resolves once all indices are successfully
108109
* configured.
110+
* @beta
109111
*/
110112
export function setIndexConfiguration(
111113
firestore: Firestore,
@@ -136,6 +138,7 @@ export function setIndexConfiguration(
136138
* @throws FirestoreError if the JSON format is invalid.
137139
* @returns A `Promise` that resolves once all indices are successfully
138140
* configured.
141+
* @beta
139142
*/
140143
export function setIndexConfiguration(
141144
firestore: Firestore,

0 commit comments

Comments
 (0)