indexer: rename pgTable to pgIndexerTable (#110)

This enables developers to use plain pgTable and pgIndexerTable in the same schema file.
apibara · Oct 30, 2024 · 0912ce5 · 0912ce5
2 parents 25fe12b + ec7cd32
commit 0912ce5
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 6 deletions.
diff --git a/change/@apibara-indexer-43e28d2b-5062-4907-8504-f0287b439697.json b/change/@apibara-indexer-43e28d2b-5062-4907-8504-f0287b439697.json
@@ -0,0 +1,7 @@
+{
+  "type": "prerelease",
+  "comment": "indexer: rename pgTable to pgIndexerTable",
+  "packageName": "@apibara/indexer",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/examples/starknet-indexer/src/indexer.ts b/examples/starknet-indexer/src/indexer.ts
@@ -1,15 +1,15 @@
 import { defineIndexer, useSink } from "@apibara/indexer";
 import {
   drizzle as drizzleSink,
-  pgTable,
+  pgIndexerTable,
 } from "@apibara/indexer/sinks/drizzle";
 import { StarknetStream } from "@apibara/starknet";
 import consola from "consola";
 import { bigint } from "drizzle-orm/pg-core";
 import { drizzle } from "drizzle-orm/postgres-js";
 import postgres from "postgres";
 
-const headers = pgTable("headers", {
+const headers = pgIndexerTable("headers", {
   number: bigint("number", { mode: "bigint" }),
 });
 

diff --git a/packages/indexer/src/sinks/drizzle/drizzle.test.ts b/packages/indexer/src/sinks/drizzle/drizzle.test.ts
@@ -15,9 +15,9 @@ import { generateMockMessages } from "../../testing";
 import { getMockIndexer } from "../../testing/indexer";
 import type { Int8Range } from "./Int8Range";
 import { drizzle as drizzleSink } from "./drizzle";
-import { getDrizzleCursor, pgTable } from "./utils";
+import { getDrizzleCursor, pgIndexerTable } from "./utils";
 
-const testTable = pgTable("test_table", {
+const testTable = pgIndexerTable("test_table", {
   id: serial("id").primaryKey(),
   data: text("data"),
 });

diff --git a/packages/indexer/src/sinks/drizzle/utils.ts b/packages/indexer/src/sinks/drizzle/utils.ts
@@ -29,7 +29,7 @@ export type CursorColumnBuilder = NotNull<
 >;
 
 // Redefining the type of `pgTable` to include the `_cursor` column.
-export type PgTableWithCursorFn<
+export type PgIndexerTableWithCursorFn<
   TSchema extends string | undefined = undefined,
 > = <
   TTableName extends string,
@@ -66,7 +66,11 @@ export type PgInsertValue<TTable extends PgTable> = Omit<
   "_cursor"
 >;
 
-export const pgTable: PgTableWithCursorFn = (name, columns, extraConfig?) => {
+export const pgIndexerTable: PgIndexerTableWithCursorFn = (
+  name,
+  columns,
+  extraConfig?,
+) => {
   return drizzlePgTable(
     name,
     {