Skip to content

refactor: improve partitioning code #2447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

refactor: improve partitioning code #2447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion firestore-bigquery-export/firestore-bigquery-change-tracker/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"url": "github.com/firebase/extensions.git",
"directory": "firestore-bigquery-export/firestore-bigquery-change-tracker"
},
"version": "1.1.38",
"version": "2.0.0",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

made it a breaking change as API for package changes

"description": "Core change-tracker library for Cloud Firestore Collection BigQuery Exports",
"main": "./lib/index.js",
"scripts": {
Expand Down
32 changes: 9 additions & 23 deletions firestore-bigquery-export/firestore-bigquery-change-tracker/src/bigquery/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as admin from "firebase-admin";
import * as bigquery from "@google-cloud/bigquery";
import { DocumentReference } from "firebase-admin/firestore";
import * as traverse from "traverse";
Expand Down Expand Up @@ -45,25 +44,9 @@ import { tableRequiresUpdate, viewRequiresUpdate } from "./checkUpdates";
import { parseErrorMessage, waitForInitialization } from "./utils";

export { RawChangelogSchema, RawChangelogViewSchema } from "./schema";

export interface FirestoreBigQueryEventHistoryTrackerConfig {
datasetId: string;
tableId: string;
datasetLocation?: string | undefined;
transformFunction?: string | undefined;
timePartitioning?: string | undefined;
timePartitioningField?: string | undefined;
timePartitioningFieldType?: string | undefined;
timePartitioningFirestoreField?: string | undefined;
clustering: string[] | null;
databaseId?: string | undefined;
wildcardIds?: boolean;
bqProjectId?: string | undefined;
backupTableId?: string | undefined;
useNewSnapshotQuerySyntax?: boolean;
skipInit?: boolean;
kmsKeyName?: string | undefined;
}
import type { Config } from "./types";
import { PartitioningConfig } from "./partitioning/config";
export type { Config } from "./types";
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will have to decide what to name this type we're exporting

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CorieW suggestions here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we just keep it the same

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just Config seems fine to me


/**
* An FirestoreEventHistoryTracker that exports data to BigQuery.
Expand All @@ -80,12 +63,15 @@ export class FirestoreBigQueryEventHistoryTracker
{
bq: bigquery.BigQuery;
_initialized: boolean = false;
partitioningConfig: PartitioningConfig;

constructor(public config: FirestoreBigQueryEventHistoryTrackerConfig) {
constructor(public config: Config) {
this.bq = new bigquery.BigQuery();

this.bq.projectId = config.bqProjectId || process.env.PROJECT_ID;

this.partitioningConfig = new PartitioningConfig(this.config.partitioning);

if (!this.config.datasetLocation) {
this.config.datasetLocation = "us";
}
Expand All @@ -96,7 +82,7 @@ export class FirestoreBigQueryEventHistoryTracker
await this.initialize();
}

const partitionHandler = new Partitioning(this.config);
const partitionHandler = new Partitioning(this.partitioningConfig);

const rows = events.map((event) => {
const partitionValue = partitionHandler.getPartitionValue(event);
Expand Down Expand Up @@ -327,7 +313,7 @@ export class FirestoreBigQueryEventHistoryTracker
const dataset = this.bigqueryDataset();
const table = dataset.table(changelogName);
const [tableExists] = await table.exists();
const partitioning = new Partitioning(this.config, table);
const partitioning = new Partitioning(this.partitioningConfig, table);
const clustering = new Clustering(this.config, table);

if (tableExists) {
Expand Down
Loading