สร้างแอปซื้อขายแบบเรียลไทม์ด้วย Firebase SQL Connect (เว็บ)

1. ก่อนเริ่มต้น

ใน Codelab นี้ คุณจะได้ผสานรวม Firebase SQL Connect กับฐานข้อมูล Cloud SQL เพื่อสร้าง Friendly Exchange ซึ่งเป็นเว็บแอปตลาดหุ้นอีโมจิแบบเรียลไทม์

แอปที่เสร็จสมบูรณ์จะแสดงฟีเจอร์ขั้นสูงของ SQL Connect ซึ่งรวมถึง

  • SQL ดั้งเดิม: เรียกใช้คำสั่งภาษาในการจัดการข้อมูล (DML) และนิพจน์ตารางทั่วไป (CTE) ที่ซับซ้อนอย่างปลอดภัยโดยใช้ _execute และ _select
  • มุมมอง SQL: สร้างออบเจ็กต์ GraphQL ที่เข้มงวดและปลอดภัยตามประเภทซึ่งรองรับโดยการค้นหา Postgres แบบไดนามิกโดยใช้คำสั่ง @view
  • การติดตามแบบเรียลไทม์: ซิงค์ UI ส่วนหน้าโดยใช้@refreshทริกเกอร์
  • ธุรกรรมแบบอะตอม: เชื่อมโยงการดำเนินการหลายอย่างและตรวจสอบสถานะโดยใช้ @transaction และ @check
  • (ไม่บังคับ) การค้นหาเชิงพื้นที่และเวกเตอร์: ใช้ประโยชน์จาก PostGIS และ pgvector เพื่อค้นหาสินทรัพย์ที่กำลังมาแรงใกล้กับพิกัดของผู้ใช้ และทำการค้นหาเชิงความหมาย
  • (ไม่บังคับ) ตัวแก้ไขที่กำหนดเอง: เชื่อมต่อตรรกะ Cloud Run ที่กำหนดเองกับสคีมา GraphQL เพื่อสร้างพาดหัวข่าวการซื้อขายที่ AI สร้างขึ้น

ข้อกำหนดเบื้องต้น

คุณต้องมีความเข้าใจอย่างถ่องแท้เกี่ยวกับไวยากรณ์ JavaScript/TypeScript, React และ SQL พื้นฐาน

สิ่งที่คุณจะได้เรียนรู้

  • วิธีใช้ SQL ดั้งเดิมเพื่อเชื่อมช่องว่างระหว่าง GraphQL ที่ประกาศและตรรกะ PostgreSQL ดิบ
  • วิธีผสานรวมส่วนขยาย Postgres เช่น PostGIS เข้ากับการค้นหาฐานข้อมูลโดยตรง
  • วิธีบังคับใช้ตรรกะที่ซับซ้อนโดยใช้บล็อก @transaction แบบแยกส่วน
  • วิธีสร้าง @views ที่ปลอดภัยตามประเภทสำหรับลีดเดอร์บอร์ดและสถิติ
  • วิธีตั้งค่าการสมัครใช้บริการแบบเรียลไทม์โดยใช้ @refresh

สิ่งที่คุณต้องมี

  • Git
  • โค้ด Visual Studio
  • ติดตั้ง Node.js
  • โปรเจ็กต์ Firebase ในแพ็กเกจราคา Blaze แบบจ่ายเมื่อใช้ (จำเป็นสำหรับตัวแก้ไขที่กำหนดเองและ Vertex AI)

2. ตั้งค่าสภาพแวดล้อมในการพัฒนาซอฟต์แวร์

ขั้นตอนนี้จะแนะนําการตั้งค่าส่วนหน้าและการกําหนดค่าอินสแตนซ์ Cloud SQL สําหรับฟีเจอร์ขั้นสูง

  1. โคลนที่เก็บโปรเจ็กต์และติดตั้งการอ้างอิงที่จำเป็นสำหรับแอป
git clone https://github.com/firebaseextended/codelab-dataconnect-web
cd codelab-dataconnect-web
git switch emoji-init
npm install
  1. เปิดโฟลเดอร์ที่โคลนโดยใช้ Visual Studio Code แล้วติดตั้ง Firebase SQL Connect Visual Studio Extension
  2. ตรวจสอบว่า Firebase CLI เป็นเวอร์ชันล่าสุดในเทอร์มินัล (จำเป็นสำหรับฟีเจอร์ใหม่ๆ เช่น @refresh และ SQL ดั้งเดิม)
npm uninstall -g firebase-tools
npm install -g firebase-tools
firebase login
firebase use your-project-id
firebase init

(เลือกโฮสติ้ง การตรวจสอบสิทธิ์ และการเชื่อมต่อ SQL)

สร้าง SDK การเชื่อมต่อ SQL: เรียกใช้คำสั่งต่อไปนี้

firebase dataconnect:sdk:generate
  1. เชื่อมต่อเว็บแอปกับโปรเจ็กต์ Firebase: ลงทะเบียนเว็บแอปในโปรเจ็กต์ Firebase โดยใช้ คอนโซล Firebase
    1. เปิดโปรเจ็กต์ แล้วคลิกเพิ่มแอป (เลือกไอคอนเว็บ)
    2. ตอนนี้ให้ข้ามการตั้งค่า SDK และการกำหนดค่าไปก่อน แต่โปรดคัดลอกออบเจ็กต์ firebaseConfig ที่สร้างขึ้น
    3. เปิด lib/firebase.tsx ในตัวแก้ไขโค้ด แล้วแทนที่ตัวยึดตำแหน่งที่มีอยู่ด้วยการกำหนดค่าที่คุณเพิ่งคัดลอก
const firebaseConfig = {
  apiKey: "API_KEY",
  authDomain: "PROJECT_ID.firebaseapp.com",
  projectId: "PROJECT_ID",
  storageBucket: "PROJECT_ID.firebasestorage.app",
  messagingSenderId: "SENDER_ID",
  appId: "APP_ID"
};
  1. เรียกใช้เซิร์ฟเวอร์การพัฒนา
npm run dev

3. ตรวจสอบโค้ดเบสเริ่มต้น

ในส่วนนี้ คุณจะได้สำรวจส่วนสำคัญของโค้ดเบสเริ่มต้นของแอป แม้ว่าคุณจะต้องเขียนสคีมาและการค้นหาตั้งแต่ต้น แต่การทำความเข้าใจวิธีที่ส่วนหน้าเชื่อมต่อเพื่อโต้ตอบกับ SQL Connect ก็เป็นประโยชน์

โครงสร้างโฟลเดอร์และไฟล์

ไดเรกทอรี dataconnect/

โฟลเดอร์นี้มีคำจำกัดความของแบ็กเอนด์ ซึ่งรวมถึงทุกอย่างตั้งแต่โครงสร้างฐานข้อมูลไปจนถึงการค้นหา SQL ที่เฉพาะเจาะจงซึ่งแอปของคุณได้รับอนุญาตให้เรียกใช้

  • schema/schema.gql: ที่ที่คุณจะกําหนดตาราง Postgres ฐานโดยใช้ประเภท GraphQL มาตรฐาน
  • schema/views.gql: ที่ที่คุณจะกำหนดมุมมอง SQL แบบอ่านอย่างเดียวที่ซับซ้อน (เช่น ลีดเดอร์บอร์ด) โดยใช้คำสั่ง @view
  • friendly-exchange/queries.gql และ mutations.gql: "ตัวเชื่อม" ของคุณ ส่วนนี้คือที่ที่คุณจะกำหนดการค้นหาที่แน่นอนและ SQL ดั้งเดิม (_execute, _select) ที่แอปของคุณอนุญาต
  • dataconnect.yaml: ไฟล์การกำหนดค่าที่กำหนดการตั้งค่าการสร้าง SDK และการติดตั้งใช้งาน Cloud SQL

ไดเรกทอรี lib/

มีตรรกะของแอปพลิเคชัน การตรวจสอบสิทธิ์ และการโต้ตอบกับ Firebase SQL Connect SDK

  • firebase.tsx: จัดการการเริ่มต้นของแอป Firebase, Auth และอินสแตนซ์ SQL Connect
  • ExchangeService.tsx: นี่คือตัวเชื่อมระหว่างคอมโพเนนต์ React กับฐานข้อมูล โดยจะห่อหุ้มฟังก์ชัน SDK ที่สร้างขึ้น (เช่น buyStock หรือ sellStock) ในฟังก์ชันแบบอะซิงโครนัสมาตรฐานเพื่อจัดการการตรวจหาข้อผิดพลาด ตรรกะทางธุรกิจ และการแจ้งเตือนแบบป๊อปอัป

SDK ที่สร้างขึ้น

เมื่อคุณเขียนการค้นหาหรือการเปลี่ยนแปลงใน SQL Connect ส่วนขยาย VS Code จะสร้าง SDK ที่มีการพิมพ์อย่างเข้มงวดโดยอัตโนมัติ ในโปรเจ็กต์นี้ ส่วนหน้าจะนำเข้าฟังก์ชันเหล่านี้จาก @dataconnect/generated โดยตรง

4. กำหนดสคีมาสำหรับการแลกเปลี่ยนอีโมจิ

ในส่วนนี้ คุณจะกำหนดโครงสร้างและความสัมพันธ์ระหว่างเอนทิตีหลักในแอปพลิเคชันการซื้อขาย เอนทิตี เช่น User, Emoji, StockOwnership, Event และ PriceHistory จะได้รับการแมปกับตารางฐานข้อมูล โดยมีการสร้างความสัมพันธ์โดยใช้ Firebase SQL Connect และคำสั่งสคีมา GraphQL

เมื่อมีสคีมานี้แล้ว แอปของคุณจะพร้อมจัดการทุกอย่าง ตั้งแต่การดำเนินการธุรกรรมซื้อ/ขายและการอัปเดตลีดเดอร์บอร์ดทั่วโลก ไปจนถึงการแมปเทรนด์เชิงพื้นที่ในท้องถิ่น

เอนทิตีและความสัมพันธ์หลัก

  • อีโมจิ: มีรายละเอียดที่สำคัญ เช่น สัญลักษณ์ ชื่อ ราคา และแนวโน้ม ซึ่งแอปใช้เพื่อแสดงตลาด
  • ผู้ใช้: ติดตามโปรไฟล์ของเทรดเดอร์ คะแนนที่มี (สกุลเงิน) และพิกัดทางภูมิศาสตร์สำหรับการสแกนเรดาร์ในพื้นที่
  • ความสัมพันธ์: ตารางการเข้าร่วม StockOwnership จะติดตามจำนวนการแชร์ที่ผู้ใช้เฉพาะรายเป็นเจ้าของอีโมจิหนึ่งๆ ประเภท Event และ PriceHistory ทำหน้าที่เป็นบัญชีแยกประเภทที่แก้ไขไม่ได้ ซึ่งบันทึกผลกระทบต่อตลาดและจุดราคาในอดีตเมื่อเวลาผ่านไป

ตั้งค่าตารางผู้ใช้

ประเภท User กำหนดผู้ค้าในระบบ โดยจะติดตามยอดคงเหลือ บทบาท และสถานที่ตั้งจริงสำหรับการค้นหาภูมิสารสนเทศเชิงพื้นที่

คัดลอกแล้ววางข้อมูลโค้ดต่อไปนี้ลงในไฟล์ dataconnect/schema/schema.gql

# Users
# user-stockOwnership is a one-to-many relationship, user-events is a one-to-many relationship
# Utilizes the Firebase Auth uid expression as the primary key
type User @table {
  id: String! @default(expr: "auth.uid")
  username: String!
  profileImage: String
  role: String! @default(value: "USER")
  points: Float! @default(value: 100.0)
  city: String @default(value: "Las Vegas")
  latitude: Float @default(value: 36.1699)
  longitude: Float @default(value: -115.1398)
}

สิ่งสำคัญที่ได้เรียนรู้

  • id: เชื่อมโยงโดยตรงกับการตรวจสอบสิทธิ์ Firebase โดยใช้ @default(expr: "auth.uid") วิธีนี้ช่วยให้มั่นใจได้ว่าข้อมูลระบุตัวตนของฐานข้อมูลและข้อมูลระบุตัวตนของ Auth จะเป็นแบบ 1:1 อย่างปลอดภัย ซึ่งจะป้องกันไม่ให้ผู้ใช้ปลอมแปลงรหัส
  • points: สกุลเงินเสมือนที่ใช้ในการซื้อขาย โดยค่าเริ่มต้นจะเป็น 100.0 สำหรับผู้ใช้ใหม่

ตั้งค่าตารางอีโมจิ

ประเภท Emoji จะกำหนดชิ้นงานหลักที่ซื้อขาย รวมถึงฟิลด์สำหรับการค้นหาข้อความมาตรฐาน

คัดลอกและวางข้อมูลโค้ดนี้ลงในไฟล์ dataconnect/schema/schema.gql

# Emojis
# emoji-stockOwnership is a one-to-many relationship, emoji-priceHistory is a one-to-many relationship
# Implements @searchable directives for full-text search
type Emoji @table {
  id: UUID! @default(expr: "uuidV4()")
  symbol: String!
  name: String! @searchable
  tags: [String!]
  description: String! @searchable
  currentPrice: Float! @default(value: 10.0)
  trend: Float! @default(value: 0.0)
}

สิ่งสำคัญที่ได้เรียนรู้

  • name & description: ใช้คำสั่ง @searchable เพื่อเพิ่มประสิทธิภาพคอลัมน์เหล่านี้สำหรับการค้นหาข้อความแบบเต็มมาตรฐาน

ตั้งค่าตาราง StockOwnership

StockOwnership ประเภทนี้เป็นตารางรวมที่จัดการความสัมพันธ์แบบกลุ่มต่อกลุ่มระหว่างผู้ใช้กับอีโมจิที่ผู้ใช้เป็นเจ้าของ คัดลอกและวางข้อมูลโค้ดนี้ลงในไฟล์ dataconnect/schema/schema.gql

# Join table for many-to-many relationship between users and emojis
# The 'key' param signifies the primary key(s) of this table
# In this case, the keys are [user, emoji], the generated fields of the reference types
type StockOwnership @table(key: ["user", "emoji"]) {
  user: User!
  emoji: Emoji!
  shares: Int! @default(value: 0)
}

สิ่งสำคัญที่ได้เรียนรู้

  • key: ["user", "emoji"]: สร้างคีย์หลักแบบผสม ผู้ใช้จะมีบันทึกแยกกัน 2 รายการสำหรับอีโมจิเดียวกันไม่ได้ เนื่องจากระบบจะบังคับใช้ความไม่ซ้ำกันต่อคู่
  • การอ้างอิงโดยนัย: เมื่ออ้างอิงประเภท User และ Emoji โดยตรง SQL Connect จะสร้างคีย์นอก userId: String! และ emojiId: UUID! โดยอัตโนมัติในเบื้องหลัง

ตั้งค่าตาราง Event และ PriceHistory

ประเภทเหล่านี้แสดงบัญชีแยกประเภทของแอปพลิเคชัน โดยบันทึกสิ่งที่เกิดขึ้นและวิธีที่ราคาเปลี่ยนแปลงอย่างแม่นยำ คัดลอกและวางข้อมูลโค้ดสุดท้ายลงในไฟล์ dataconnect/schema/schema.gql

# Events
# Event-User is a many-to-one relationship, Event-Emoji is a many-to-one relationship
# Evaluates the createdAt timestamp purely on the server side using the request.time expression
type Event @table {
  id: UUID! @default(expr: "uuidV4()")
  user: User!
  emoji: Emoji!
  impact: Float!
  description: String!
  createdAt: Timestamp! @default(expr: "request.time")
}

# Price History
# PriceHistory-Emoji is a many-to-one relationship
type PriceHistory @table {
  id: UUID! @default(expr: "uuidV4()")
  emoji: Emoji!
  price: Float!
  recordedAt: Timestamp! @default(expr: "request.time")
}

สิ่งสำคัญที่ได้เรียนรู้

  • createdAt & recordedAt: ตั้งค่าโดยอัตโนมัติเป็นเวลาที่แน่นอนที่ธุรกรรมในฐานข้อมูลเกิดขึ้นโดยใช้ @default(expr: "request.time") ซึ่งจะช่วยป้องกันไม่ให้ไคลเอ็นต์บิดเบือนการประทับเวลา

ฟิลด์และค่าเริ่มต้นที่สร้างขึ้นโดยอัตโนมัติ

สคีมาใช้การแสดงออก เช่น @default(expr: "uuidV4()") และ @default(expr: "auth.uid") เพื่อสร้างรหัสที่ไม่ซ้ำกันโดยอัตโนมัติและบังคับใช้ความเป็นเจ้าของโดยไม่ต้องให้แอปพลิเคชันไคลเอ็นต์ระบุรหัสเหล่านั้น

5. ดึงข้อมูลตลาดและข้อมูลผู้ใช้

ในส่วนนี้ คุณจะแทรกข้อมูลตลาดจำลองลงในฐานข้อมูล จากนั้นใช้ตัวเชื่อมต่อ (การค้นหา) และโค้ด TypeScript เพื่อเรียกตัวเชื่อมต่อเหล่านี้ในเว็บแอปพลิเคชัน เมื่อสิ้นสุดแล้ว แอปจะดึงและแสดงตลาดอีโมจิสด โปรไฟล์ผู้ใช้ และลีดเดอร์บอร์ดแบบไดนามิกจากฐานข้อมูลได้โดยตรง

แทรกข้อมูลตลาดและข้อมูลผู้ใช้จำลอง

  1. ใน VSCode ให้เปิด dataconnect/seed.gql
  2. ตรวจสอบว่าโปรแกรมจำลองในส่วนขยาย Firebase SQL Connect กำลังทำงานอยู่ (หรืออินสแตนซ์ Cloud SQL เชื่อมต่ออยู่)
  3. คุณควรเห็นปุ่ม CodeLens Run (local) หรือ Run (Production) ที่ด้านบนของไฟล์ คลิกเพื่อแทรกข้อมูลอีโมจิจำลองและประวัติราคาเริ่มต้นลงในฐานข้อมูล
  4. ตรวจสอบเทอร์มินัลการดำเนินการ SQL Connect เพื่อยืนยันว่าเพิ่มข้อมูลสำเร็จแล้ว

ใช้การค้นหาพื้นฐาน

ก่อนอื่น มาค้นหาตารางมาตรฐานที่คุณกําหนดไว้ในสคีมา

  1. เปิด dataconnect/friendly-exchange/queries.gql
  2. เพิ่มการค้นหาต่อไปนี้เพื่อเรียกข้อมูลแดชบอร์ด โปรไฟล์ผู้ใช้ และประวัติราคาพื้นฐาน
# Get dashboard data including top emojis by price and recent market events
query GetDashboardData
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
) {
  emojis(orderBy: [{ currentPrice: DESC }]) {
    id
    symbol
    name
    description
    currentPrice
    trend
  }
  events(orderBy: [{ createdAt: DESC }], limit: 15) {
    id
    description
    impact
    createdAt
    user {
      username
      profileImage
    }
    emoji {
      symbol
    }
  }
}

# Get current authenticated user profile and their stock ownership using auth.uid
query GetUserProfile @auth(level: USER) {
  user(id_expr: "auth.uid") {
    points
    username
    profileImage
    role
    stockOwnerships_on_user {
      shares
      emoji {
        id
        symbol
        currentPrice
        name
      }
    }
    city
    latitude
    longitude
  }
}

# Get price history for a specific emoji ordered by time
query GetPriceHistory($emojiId: UUID!, $limit: Int)
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
) {
  priceHistories(
    where: { emojiId: { eq: $emojiId } }
    orderBy: [{ recordedAt: ASC }]
    limit: $limit
  ) {
    price
    recordedAt
  }
}

สิ่งสำคัญที่ได้เรียนรู้

  • emojis() / events(): ฟิลด์การค้นหา GraphQL ที่สร้างขึ้นโดยอัตโนมัติเพื่อดึงข้อมูลจากตารางโดยตรง
  • id_expr: "auth.uid": รักษาความปลอดภัยในการเข้าถึงโดยการดึงโปรไฟล์ผู้ใช้ที่ตรงกับโทเค็นของผู้ใช้ Firebase ที่ได้รับการตรวจสอบสิทธิ์ในปัจจุบัน
  • _on_: อนุญาตให้เข้าถึงฟิลด์โดยตรงจากประเภทที่เชื่อมโยงซึ่งมีความสัมพันธ์คีย์นอก stockOwnerships_on_user จะดึงข้อมูลพอร์ตโฟลิโอทั้งหมดของผู้ใช้ในการค้นหาครั้งเดียว
  • insecureReason: ต้องระบุเมื่อเปิดเผยการดำเนินการต่อ PUBLIC โดยจะระบุอย่างชัดเจนว่าเหตุใดจึงแสดงข้อมูลนี้ได้อย่างปลอดภัยโดยไม่ต้องมีการตรวจสอบสิทธิ์

สร้างมุมมอง SQL ที่ปลอดภัยต่อประเภท

ก่อนเขียน SQL ที่กำหนดเอง คุณควรทำความเข้าใจวิธีต่างๆ ที่ Firebase SQL Connect จัดการคำค้นหา

  • GraphQL มาตรฐาน: เหมาะที่สุดสำหรับ CRUD พื้นฐานและความสัมพันธ์แบบง่ายๆ ที่มีความปลอดภัยในการกำหนดประเภทแบบต้นทางถึงปลายทางที่เข้มงวด
  • มุมมอง SQL (@view): เหมาะที่สุดสำหรับ SQL ที่ซับซ้อนแบบอ่านอย่างเดียว (เช่น ลีดเดอร์บอร์ดที่ใช้ฟังก์ชันหน้าต่าง) ซึ่งคุณยังต้องการให้ระบบแสดงออบเจ็กต์ GraphQL ที่เข้มงวดและปลอดภัยตามประเภทไปยังไคลเอ็นต์
  • SQL ดั้งเดิม (_execute / _select): เหมาะที่สุดสำหรับการเรียกใช้ DML, CTE หรือส่วนขยาย PostGIS โดยตรง คุณแลกเปลี่ยนการพิมพ์อย่างเข้มงวดในเวลาคอมไพล์กับความยืดหยุ่นสูงสุดในเวลาดำเนินการ (แสดงผล JSON แบบไดนามิก)

หากต้องการสร้างลีดเดอร์บอร์ดและแผนภูมิประกาย เราต้องคำนวณค่าเฉลี่ยเคลื่อนที่และจัดอันดับผู้ใช้ นี่คือกรณีการใช้งานสำหรับ @view

  1. เปิด dataconnect/schema/views.gql
  2. เพิ่มมุมมองต่อไปนี้เพื่อคำนวณสถิติที่จำเป็นในเซิร์ฟเวอร์
# Rank users on a leaderboard based on their total net worth
type TopTrader
@view(
  sql: """
  SELECT
    u.id,
    u.username,
    u.profile_image,
    (u.points + COALESCE(SUM(so.shares * e.current_price), 0)) AS net_worth,
    RANK() OVER (ORDER BY (u.points + COALESCE(SUM(so.shares * e.current_price), 0)) DESC) AS rank
  FROM "user" u
  LEFT JOIN stock_ownership so ON u.id = so.user_id
  LEFT JOIN emoji e ON so.emoji_id = e.id
  WHERE u.id != 'system_market_maker'
  GROUP BY u.id, u.username, u.profile_image, u.points
  """
) {
  id: String
  username: String
  profileImage: String
  netWorth: Float
  rank: Int
}

# Identify the top shareholder (whale) for each emoji and their total ownership percentage
type EmojiWhaleStat
  @view(
    sql: """
    WITH total_shares AS (
      SELECT emoji_id, SUM(shares) AS total_supply
      FROM stock_ownership WHERE shares > 0 GROUP BY emoji_id
    ),
    ranked_holders AS (
      SELECT
        so.emoji_id, u.username AS whale_username, u.profile_image AS whale_profile_image,
        so.shares AS whale_shares, ts.total_supply,
        ROUND((so.shares::DECIMAL / NULLIF(ts.total_supply, 0)) * 100, 2) AS whale_percentage,
        RANK() OVER (PARTITION BY so.emoji_id ORDER BY so.shares DESC) AS holder_rank
      FROM stock_ownership so
      JOIN "user" u ON u.id = so.user_id
      JOIN total_shares ts ON ts.emoji_id = so.emoji_id
      WHERE so.shares > 0
    )
    SELECT emoji_id, whale_username, whale_profile_image, whale_shares, total_supply, whale_percentage
    FROM ranked_holders WHERE holder_rank = 1
    """
  ) {
  emojiId: UUID
  whaleUsername: String
  whaleProfileImage: String
  whaleShares: Int
  totalSupply: Int
  whalePercentage: Float
}

# Calculate the moving average of historical prices for each emoji
type EmojiHistoryStat
  @view(
    sql: """
    SELECT
      emoji_id, price, recorded_at,
      AVG(price) OVER (PARTITION BY emoji_id ORDER BY recorded_at ROWS BETWEEN 4 PRECEDING AND CURRENT ROW) as moving_average
    FROM price_history
    """
  ) {
  emojiId: UUID
  price: Float
  recordedAt: Timestamp
  movingAverage: Float
}

# Combine recent price updates and major news events into a single chronological feed
type TickerFeed
  @view(
    sql: """
    WITH latest_prices AS (
      SELECT emoji_id, MAX(recorded_at) as last_trade_time
      FROM price_history GROUP BY emoji_id
    )
    SELECT
      'PRICE' as type, e.symbol, e.name, e.current_price, e.trend,
      '' as description, lp.last_trade_time as event_time
    FROM emoji e JOIN latest_prices lp ON e.id = lp.emoji_id
    UNION ALL
    SELECT
      'NEWS' as type, e.symbol, '' as name, 0 as current_price, 0 as trend,
      ev.description, ev.created_at as event_time
    FROM event ev JOIN emoji e ON ev.emoji_id = e.id
    """
  ) {
  type: String
  symbol: String
  name: String
  currentPrice: Float
  trend: Float
  description: String
  eventTime: Timestamp
}

# Retrieve the 15 most recent price points for each emoji to render sparkline charts
type EmojiSparkline
  @view(
    sql: """
    WITH RankedPrices AS (
      SELECT
        emoji_id, price, recorded_at,
        ROW_NUMBER() OVER(PARTITION BY emoji_id ORDER BY recorded_at DESC) as rn
      FROM price_history
    )
    SELECT emoji_id, price, recorded_at
    FROM RankedPrices WHERE rn <= 15 ORDER BY recorded_at ASC
    """
  ) {
  emojiId: UUID
  price: Float
  recordedAt: Timestamp
}

ตอนนี้ให้เปิด dataconnect/friendly-exchange/queries.gql แล้วแทนที่ TODO เพื่อดึงข้อมูลจากมุมมองใหม่

# Get emoji whale statistics to identify top shareholders from emojiWhaleStats view
query GetEmojiWhaleStats
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
) {
  emojiWhaleStats {
    emojiId
    whaleUsername
    whaleProfileImage
    whaleShares
    totalSupply
    whalePercentage
  }
}

# Get historical price and moving average stats for a specific emoji from emojiHistoryStats view
query GetEmojiHistoryStats($emojiId: UUID!)
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
) {
  emojiHistoryStats(
    where: { emojiId: { eq: $emojiId } }
    orderBy: [{ recordedAt: ASC }]
    limit: 50
  ) {
    price
    movingAverage
    recordedAt
  }
}

# List top traders ordered by rank from topTraders view
query GetTopTraders
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
) {
  topTraders(orderBy: [{ rank: ASC }]) {
    id
    username
    profileImage
    netWorth
    rank
  }
}

# Get chronological market ticker feed of recent events from tickerFeeds view
query GetChronologicalTicker
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
) {
  tickerFeeds(orderBy: [{ eventTime: DESC }], limit: 30) {
    type
    symbol
    name
    currentPrice
    trend
    description
    eventTime
  }
}

# Get simple price points for rendering emoji sparkline charts from emojiSparklines view
query GetEmojiSparklines
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
) {
  emojiSparklines {
    emojiId
    price
    recordedAt
  }
}

สิ่งสำคัญที่ได้เรียนรู้

  • @view: ห่อหุ้มตรรกะฐานข้อมูลที่ซับซ้อนในเซิร์ฟเวอร์ในขณะที่ยังคงโค้ดฝั่งไคลเอ็นต์เป็นแบบพิมพ์อย่างเคร่งครัด SQL Connect จะแมปฟิลด์ GraphQL ใน @view ประเภทกับคอลัมน์ที่คำสั่ง SELECT แสดงผล
  • อ่านอย่างเดียว: มุมมองไม่มีคีย์หลักและแก้ไขโดยตรงไม่ได้
  • การสร้างคําค้นหา: สังเกตว่า topTraders() และ emojiSparklines() ทำงานเหมือนกับการค้นหาตารางมาตรฐานทุกประการ

ใช้คำค้นหา

SQL Connect จะสร้างคำค้นหามาตรฐานโดยอัตโนมัติสำหรับฟิลด์ใดก็ตามที่ทำเครื่องหมายด้วยคำสั่ง @searchable ในสคีมา

เพิ่มการค้นหาต่อไปนี้ลงใน dataconnect/friendly-exchange/queries.gql เพื่อเปิดใช้การค้นหาข้อความแบบเต็ม

# Search emojis using full-text search query
query SearchEmojis($query: String)
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
) {
  emojis_search(query: $query) {
    id
    symbol
    name
    description
    currentPrice
    trend
  }
}

สิ่งสำคัญที่ได้เรียนรู้

  • emojis_search: ฟิลด์คำค้นหาที่สร้างขึ้นโดยอัตโนมัติเนื่องจากคุณใช้ @searchable กับฟิลด์ name และ description ในสคีมา Emoji

สร้าง SDK

เนื่องจากคุณได้กำหนดการค้นหาและมุมมองใหม่ในไฟล์ GraphQL แล้ว คุณจึงต้องเรียกใช้เครื่องมือสร้าง SDK เพื่อให้ส่วนหน้าของ TypeScript ใช้การค้นหาและมุมมองเหล่านั้นได้อย่างปลอดภัย

เปิดเทอร์มินัลแล้วเรียกใช้คำสั่งต่อไปนี้

firebase dataconnect:sdk:generate

ผสานรวมคําค้นหาในเว็บแอป

คอมไพเลอร์ Firebase SQL Connect จะสร้าง SDK ตามไฟล์ .gql เนื่องจากแอปนี้ออกแบบมาให้เป็นแอปแบบเรียลไทม์ คุณจึงต้องใช้เมธอด subscribe ควบคู่ไปกับการอ้างอิงการค้นหาที่สร้างขึ้นในคอมโพเนนต์ต่างๆ

แทนที่บล็อก useEffect ที่ว่างเปล่าในไฟล์ต่อไปนี้ด้วยตรรกะด้านล่าง

1. หน้าแรก (

app/page.tsx

)

import { subscribe } from "@firebase/data-connect";
import {
  getDashboardDataRef,
  searchEmojisRef,
  getChronologicalTickerRef,
  getUserProfileRef,
} from "@dataconnect/generated";

// Inside the Home component:
  useEffect(() => {
    // Subscribe to realtime updates for the main market dashboard data including top emojis and recent events
    const unsubscribe = subscribe(
      getDashboardDataRef(),
      (res) => {
        if (res.data) setDashboardData(res.data);
        setIsDashboardLoading(false);
      },
      (err) => {
        console.error("Dashboard Realtime Error:", err);
        setIsDashboardLoading(false);
      },
    );
    return () => unsubscribe();
  }, [user]);

  useEffect(() => {
    // Subscribe to a realtime chronological ticker feed combining recent price updates and major news events
    const unsubscribe = subscribe(
      getChronologicalTickerRef(),
      (res) => {
        if (res.data) setTickerData(res.data);
      },
      (err) => console.error("Ticker Realtime Error:", err),
    );
    return () => unsubscribe();
  }, []);

  useEffect(() => {
    if (loading || !user) return;
    // Subscribe to realtime updates for the authenticated user's profile and stock ownership
    const unsubscribe = subscribe(
      getUserProfileRef(),
      (res) => {
        if (res.data) setProfileData(res.data);
      },
      (err) => console.error("Profile Error:", err),
    );
    return () => unsubscribe();
  }, [user, loading]);

  useEffect(() => {
    if (!debouncedSearch) {
      setSearchData(null);
      return;
    }
    
    // Subscribe to realtime full-text search results for emojis based on user input
    const unsubscribe = subscribe(
      searchEmojisRef({ query: debouncedSearch }),
      (res) => {
        if (res.data) setSearchData(res.data.emojis_search);
        setIsSearchLoading(false);
      },
      (err) => {
        console.error("Text Search Error:", err);
        setIsSearchLoading(false);
      },
    );

    return () => unsubscribe();
  }, [debouncedSearch]);

2. คอมโพเนนต์โปรไฟล์ผู้ใช้

app/profile/page.tsx

อัปเดต Hook ดังนี้

import { subscribe } from "@firebase/data-connect";
import { getUserProfileRef } from "@dataconnect/generated";

useEffect(() => {
  // Subscribe to realtime updates for the authenticated user's profile and stock ownership
  const unsubscribe = subscribe(
    getUserProfileRef(),
    (res) => {
      if (res.data) {
        setData(res.data);
      }
      setIsLoading(false);
    },
    (err) => {
      console.error("Profile Realtime Error:", err);
      setIsLoading(false);
    },
  );
  return () => unsubscribe();
}, []);

components/NavBar.tsx

:

 useEffect(() => {
    // Subscribe to realtime updates for the authenticated user's profile and stock ownership
    const unsub = subscribe(
      getUserProfileRef(),
      (res) => {
        if (res.data) setData(res.data);
      },
      (err) => console.error("Navbar Balance Realtime Error:", err),
    );
    return () => unsub();
  }, []);

สำหรับ components/FloatingMenu.tsx ให้แทนที่ออบเจ็กต์ const { data } ที่สร้างขึ้นด้วยตนเองด้วยฮุกที่สร้างขึ้นด้วย

const { data, refetch: refetchDashboard } = useGetDashboardData();

 useEffect(() => {
    if (!user) return;
    // Subscribe to realtime updates for the authenticated user's profile
    const unsub = subscribe(getUserProfileRef(), (res) => {
      if (res.data) {
        setProfileData(res.data);
        setOptimisticRole(null);
      }
    });
    return () => unsub();
  }, [user]);

สิ่งสำคัญที่ได้เรียนรู้

  • getUserProfileRef / getDashboardDataRef: ฟังก์ชันที่สร้างขึ้นโดยอัตโนมัติซึ่งเตรียมคำค้นหา GraphQL เพื่อการดำเนินการ โดยจะรักษาประเภทที่เข้มงวดซึ่งกำหนดโดยตารางและมุมมอง
  • subscribe: เมธอด SQL Connect SDK ที่รับฟังการค้นหา ตอนนี้ฟังก์ชันนี้จะดึงข้อมูลเมื่อคอมโพเนนต์โหลด แต่ในขั้นตอนต่อๆ ไป เราจะอัปเกรดแบ็กเอนด์เพื่อเรียกใช้ฟังก์ชันนี้โดยอัตโนมัติเมื่อใดก็ตามที่ฐานข้อมูลมีการเปลี่ยนแปลง
  1. แผงตลาด (components/MarketPanel.tsx): ในทํานองเดียวกัน ในคอมโพเนนต์ MarketPanel (components/MarketPanel.tsx) คุณสามารถแทนที่ TODO เพื่อเรียกใช้การค้นหาหลายรายการพร้อมกันเพื่อสร้างแถบด้านข้างได้
import { subscribe } from "@firebase/data-connect";
import { getDashboardDataRef, getEmojiSparklinesRef } from "@dataconnect/generated";

// Inside the MarketPanel component:
  useEffect(() => {
    // Subscribe to realtime updates for the main market dashboard data including top emojis and recent events
    const unsub = subscribe(
      getDashboardDataRef(),
      (res) => {
        if (res.data) setData(res.data);
      },
      (err) => console.error("Market Panel Realtime Error:", err)
    );
    return () => unsub();
  }, []);

  useEffect(() => {
    // Subscribe to realtime price history updates to render emoji sparkline charts
    const unsub = subscribe(
      getEmojiSparklinesRef(),
      (res) => {
        if (res.data?.emojiSparklines) {
          setSparklineRawData(res.data.emojiSparklines);
        }
      },
      (err) => console.error("Global Sparklines Error:", err)
    );
    return () => unsub();
  }, []);


  1. หน้าลีดเดอร์บอร์ด (app/leaderboard/page.tsx)
import { subscribe } from "@firebase/data-connect";
import { getTopTradersRef } from "@dataconnect/generated";

// Inside the Leaderboard component:
  useEffect(() => {
    // Subscribe to realtime updates for the global leaderboard ranking top traders by net worth
    const unsubscribe = subscribe(
      getTopTradersRef(),
      (res) => {
        if (res.data) setData(res.data);
        setIsLoading(false);
      },
      (err) => {
        console.error("Leaderboard Realtime Error:", err);
        setIsLoading(false);
      },
    );
    return () => unsubscribe();
  }, []);

  1. โมดอลอีโมจิ (components/EmojiModal.tsx)
import { subscribe } from "@firebase/data-connect";
import {
  getEmojiHistoryStatsRef,
  getEmojiWhaleStatsRef,
} from "@dataconnect/generated";

// Inside the EmojiModal component:
  useEffect(() => {
    if (!emoji?.id) return;

    setStatsLoading(true);
    // Subscribe to realtime historical price and moving average statistics for the selected emoji
    const unsub = subscribe(
      getEmojiHistoryStatsRef({ emojiId: emoji.id }),
      (res) => {
        if (res.data) setStatsData(res.data);
        setStatsLoading(false);
      },
      (err) => {
        console.error("History Realtime Error:", err);
        setStatsLoading(false);
      },
    );
    return () => unsub();
  }, [emoji?.id]);

  useEffect(() => {
    // Subscribe to realtime whale statistics to identify the top shareholder for the selected emoji
    const unsub = subscribe(
      getEmojiWhaleStatsRef(),
      (res) => {
        if (res.data) setWhaleData(res.data);
      },
      (err) => console.error("Whale Realtime Error:", err),
    );
    return () => unsub();
  }, []);

ดูของจริง

โหลดเว็บแอปซ้ำเพื่อดูการทำงานของคำค้นหา ตอนนี้หน้าแรกและแถบด้านข้างจะแสดงรายการอิโมจิโดยดึงข้อมูลจากฐานข้อมูล PostgreSQL โดยตรง

6. จัดการการอัปเดตของผู้ใช้และธุรกรรมในตลาด

ในส่วนนี้ คุณจะใช้ฟังก์ชันการลงชื่อเข้าใช้ของผู้ใช้โดยใช้การตรวจสอบสิทธิ์ Firebase เพื่ออัปเดตหรือแทรกโปรไฟล์ผู้ใช้ (เช่น ชื่อที่แสดงและสถานที่ตั้งจริง) ใน Firebase SQL Connect นอกจากนี้ คุณยังใช้คำสั่ง @transaction และ @check ของ SQL Connect เพื่อเรียกใช้เหตุการณ์ทางการตลาดแบบหลายขั้นตอนที่ทำงานอย่างต่อเนื่องได้อย่างปลอดภัย

ติดตั้งใช้งานเครื่องมือเชื่อมต่อผู้ใช้และสถานที่ตั้ง

เปิด dataconnect/friendly-exchange/mutations.gql แทนที่ TODO ด้วยการเพิ่มการเปลี่ยนแปลงต่อไปนี้เพื่อจัดการการสร้าง การอัปเดต และการค้นหาผู้ใช้

# Upserts a user record using the Firebase Auth uid expression as the primary key
# Upsert (update or insert) a user's profile information
mutation UpsertUser($username: String!, $profileImage: String!)
@auth(level: USER) {
  user_upsert(
    data: {
      id_expr: "auth.uid"
      username: $username
      profileImage: $profileImage
    }
  )
}

# Update a user's role
mutation UpdateUserRole($role: String!) @auth(level: USER) {
  user_update(key: { id_expr: "auth.uid" }, data: { role: $role })
}

# Update a user's location
mutation UpdateUserLocation(
  $city: String!
  $latitude: Float!
  $longitude: Float!
) @auth(level: USER) {
  user_update(
    key: { id_expr: "auth.uid" }
    data: { city: $city, latitude: $latitude, longitude: $longitude }
  )
}

# Trigger a new market event for an emoji
mutation TriggerEvent(
  $emojiId: UUID!
  $impact: Float!
  $description: String!
  $now: Timestamp!
) @auth(level: USER) {
  event_insert(
    data: {
      userId_expr: "auth.uid"
      emojiId: $emojiId
      impact: $impact
      description: $description
      createdAt: $now
    }
  )
}

สิ่งสำคัญที่ได้เรียนรู้

  • id_expr: "auth.uid": ใช้ auth.uid ซึ่งได้จากโทเค็นการตรวจสอบสิทธิ์ Firebase โดยตรง การประเมินฝั่งเซิร์ฟเวอร์นี้ช่วยให้มั่นใจได้ว่าผู้ใช้จะอัปเดตได้เฉพาะข้อมูลโปรไฟล์ของตนเองเท่านั้น ซึ่งเป็นการเพิ่มเลเยอร์ความปลอดภัยที่แข็งแกร่ง

ตรรกะของเชนที่มี @transaction

จากนั้นคุณจะใช้ "ผู้สร้างตลาด" ที่ผู้ดูแลระบบสามารถเรียกใช้เพื่อจำลองกิจกรรมในตลาดแบบสุ่ม เนื่องจากต้องอัปเดตราคาของอิโมจิ บันทึกเหตุการณ์ และอัปเดตการเป็นเจ้าของสต็อกของระบบพร้อมกัน เราจึงต้องใช้ธุรกรรมแบบอะตอม

เพิ่มการเปลี่ยนแปลงนี้ลงในไฟล์ mutations.gql

# Execute a market maker trade to adjust emoji price and shares
mutation MarketMakerTrade(
  $emojiId: UUID!
  $priceImpact: Float!
  $shareDelta: Int!
  $eventDesc: String!
  $newPrice: Float!
)
@auth(
  level: USER
  insecureReason: "This operation is safe to expose to any user."
)
@transaction {
  query @redact {
    user(key: { id_expr: "auth.uid" })
      @check(
        expr: "this != null && this.role == 'ADMIN'",
        message: "Access Denied: You must have the ADMIN role to deploy the Market Maker bot."
      ) {
      role
    }
  }
  stockOwnership_upsert(
    data: {
      userId: "system_market_maker"
      emojiId: $emojiId
      shares_update: { inc: $shareDelta }
    }
  )
  emoji_update(
    id: $emojiId
    data: { currentPrice_update: { inc: $priceImpact }, trend: $priceImpact }
  )
  event_insert(
    data: {
      userId: "system_market_maker"
      emojiId: $emojiId
      impact: $priceImpact
      description: $eventDesc
    }
  )
  priceHistory_insert(data: { emojiId: $emojiId, price: $newPrice })
}

สิ่งสำคัญที่ได้เรียนรู้

  • @transaction: ช่วยให้การดำเนินการฐานข้อมูลทั้งหมด (การแทรก/อัปเดตสต็อก การอัปเดตราคาอีโมจิ การบันทึกเหตุการณ์) สำเร็จพร้อมกันหรือล้มเหลวพร้อมกัน
  • @check: คำสั่งที่ประเมินเงื่อนไขก่อนดำเนินการต่อ ในที่นี้ ระบบจะตรวจสอบว่า role ของผู้ใช้ที่ผ่านการตรวจสอบสิทธิ์คือ 'ADMIN' หรือไม่ หากผู้ใช้เป็นเพียง'USER'มาตรฐาน ระบบจะปฏิเสธธุรกรรมทั้งหมดและย้อนกลับ
  • @redact: ป้องกันไม่ให้ระบบส่งผลการค้นหา (เช่น การตรวจสอบบทบาทของผู้ใช้) กลับไปยังไคลเอ็นต์ในเพย์โหลดการตอบกลับ เพื่อให้การตอบกลับธุรกรรมสะอาด

สร้าง SDK

เนื่องจากคุณได้กำหนดการเปลี่ยนแปลงใหม่ในไฟล์ GraphQL แล้ว คุณจึงต้องเรียกใช้เครื่องมือสร้าง SDK เพื่อให้ส่วนหน้าของ TypeScript เรียกใช้ได้

เปิดเทอร์มินัลแล้วเรียกใช้คำสั่งต่อไปนี้

firebase dataconnect:sdk:generate

ผสานรวมการเปลี่ยนแปลงในเว็บแอป

ในเว็บแอป คุณจะรวมการเปลี่ยนแปลง SDK ที่สร้างขึ้นเหล่านี้ไว้ในฟังก์ชันแบบอะซิงโครนัสมาตรฐานเพื่อจัดการการตรวจหาข้อผิดพลาดและการแจ้งเตือน UI

เปิด lib/ExchangeService.tsx และตรวจสอบฟังก์ชัน Wrapper แทนที่บล็อก TODO ด้วยการติดตั้งใช้งานต่อไปนี้

import {
  upsertUser,
  updateUserLocation,
  marketMakerTrade,
  updateUserRole,
  triggerMarketCrash,
} from "@dataconnect/generated";

// Upsert (update or insert) a user's profile information and log the event
export const executeUpsertUser = async (
  username: string,
  profileImage: string,
  logEvent: (key: LogEventKey, params?: any) => void,
): Promise<void> => {
  logEvent("UPSERT_USER_MUTATION", { username });
  await upsertUser({ username, profileImage });
};

// Update a user's role and log the event
export const executeUpdateRole = async (
  role: string,
  logEvent: (key: LogEventKey, params?: any) => void
): Promise<void> => {
  logEvent("UPDATE_USER_ROLE_MUTATION", { role });
  await updateUserRole({ role });
};

// Update a user's city and geographic coordinates
export const executeUpdateLocation = async (
  city: string,
  latitude: number,
  longitude: number,
): Promise<void> => {
  await updateUserLocation({ city, latitude, longitude });
};

// Execute a random market maker trade and adjust an emoji's stock price
export const executeManualBotTrade = async (
  randomEmoji: any,
  username: string,
  logEvent: (key: LogEventKey, params?: any) => void,
): Promise<{ isBuy: boolean; tradeAmount: number }> => {
  logEvent("MARKET_MAKER_TRADE");
  const isBuy = Math.random() > 0.5;
  const tradeAmount = Number((Math.random() * (10 - 2) + 2).toFixed(2));

  await marketMakerTrade({
    emojiId: randomEmoji.id,
    priceImpact: isBuy ? tradeAmount : -tradeAmount,
    shareDelta: isBuy ? 10 : -10,
    eventDesc: `Admin ${username} triggered market event: ${randomEmoji.symbol} went ${isBuy ? "up" : "down"} by $${tradeAmount.toFixed(2)}.`,
    newPrice: Math.max(0.01, randomEmoji.currentPrice + (isBuy ? tradeAmount : -tradeAmount)),
  });

  return { isBuy, tradeAmount };
};

Triggering upsert on login: In app/src/components/Navbar.tsx, you can see how executeUpsertUser is called immediately after Firebase Authentication successfully signs a user in via Google Popup. This guarantees the SQL Connect database is synced with Firebase Auth.

See it in action

Now, click the Sign In button in the navbar. You can sign in using Firebase Authentication. After signing in:

  1. Navigate to your Profile and test out the Auto-Locate button. When you click Update Coordinates, the UpdateUserLocation mutation will execute.
  2. Open the Floating Control Panel (the purple icon in the bottom right corner).
  3. Click USER and switch your authorization level to ADMIN.
  4. Click Trigger random market activity. Because your role is now 'ADMIN', the @check directive passes, the @transaction executes, and you will instantly see the market prices update across your application!

7. Advanced operations with Native SQL

In this section, you will use Native SQL to execute complex Data Manipulation Language (DML) statements and leverage PostgreSQL-specific extensions.

While standard GraphQL and @views are ideal for strictly-typed CRUD and read-only operations, Native SQL provides execution-time flexibility. It allows you to use Common Table Expressions (CTEs) to chain multiple updates in a single database round-trip, and lets you query native PostgreSQL extensions directly.

Enable the PostGIS extension

Before we write geospatial queries, you need to enable the PostGIS extension on your Cloud SQL database.

  1. Navigate to the Google Cloud Console.
  2. Go to Cloud SQL -> select your provisioned instance -> click Cloud SQL Studio.
  3. Log into your database and execute the following command:
CREATE EXTENSION IF NOT EXISTS postgis;

Implement Native SQL Queries

Let's use Native SQL to find trending emojis near the user's physical location, and to calculate the top emojis per city using complex ranking.

  1. Open dataconnect/friendly-exchange/queries.gql.
  2. Add the following Native SQL queries using the _select field:
# Get top trending emojis partitioned by user city using native SQL
query GetTopEmojisByCity
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
) {
  cityTrends: _select(
    sql: """
    WITH city_shares AS (
      SELECT
        u.city,
        AVG(u.latitude) as latitude,
        AVG(u.longitude) as longitude,
        e.id as emoji_id,
        e.symbol,
        e.name,
        SUM(so.shares) as total_shares,
        RANK() OVER (PARTITION BY u.city ORDER BY SUM(so.shares) DESC) as rank
      FROM stock_ownership so
      JOIN "user" u ON so.user_id = u.id
      JOIN emoji e ON so.emoji_id = e.id
      WHERE u.city IS NOT NULL AND u.latitude IS NOT NULL AND so.shares > 0
      GROUP BY u.city, e.id, e.symbol, e.name
    )
    SELECT city, latitude, longitude, emoji_id, symbol, name, total_shares
    FROM city_shares
    WHERE rank = 1
    ORDER BY city ASC
    """
    params: []
  )
}

# Get trending emojis within a geographic radius using native SQL and PostGIS extension
query GetTrendingEmojisNearMe(
  $userLng: Float!
  $userLat: Float!
  $radiusMeters: Float!
)
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
) {
  regionalTrends: _select(
    sql: """
    SELECT
      e.id,
      e.symbol,
      e.name,
      e.current_price,
      e.trend,
      COUNT(so.shares)   AS regional_holders,
      SUM(so.shares)     AS regional_shares
    FROM emoji e
    JOIN stock_ownership so ON so.emoji_id = e.id
    JOIN "user" u            ON u.id = so.user_id
    WHERE u.latitude  IS NOT NULL
      AND u.longitude IS NOT NULL
      AND so.shares > 0
      AND ST_DWithin(
        ST_MakePoint(u.longitude, u.latitude)::geography,
        ST_MakePoint($1, $2)::geography,
        $3
      )
    GROUP BY e.id, e.symbol, e.name, e.current_price, e.trend
    ORDER BY regional_shares DESC
    LIMIT 10
    """
    params: [$userLng, $userLat, $radiusMeters]
  )
}

Key Takeaways

  • _select: Executes a Data Query Language (DQL) statement returning a JSON array ([Any]).
  • ST_DWithin: A native PostGIS function that calculates distances on a sphere. Native SQL allows you to use this without mapping complex geometry types into your GraphQL schema.
  • params: Variables like $userLng are bound to the SQL string via positional parameters ($1, $2, $3), preventing SQL injection.

Implement Native SQL Mutations

When a user buys or sells a stock, the system must validate their funds, deduct the cost, add the shares, update the global emoji price, and log the history. Doing this across multiple standard mutations could lead to race conditions. Instead, we can use a CTE (WITH) to do this atomically in one Native SQL execution.

Open dataconnect/friendly-exchange/mutations.gql and replace the TODOs with the following Native SQL mutations:

# Buy shares of an emoji stock
mutation BuyStock($emojiId: UUID!, $amount: Int!, $isDiscounted: Boolean!)
@auth(level: USER) {
  buyStock: _execute(
    sql: """
    WITH validated_params AS (
      SELECT
        $1::uuid AS emoji_id,
        $2::int AS amount,
        $3::boolean AS is_discounted,
        $4::text AS user_id
    ),
    target_emoji AS (
      SELECT
        e.id,
        (e.current_price * (CASE WHEN vp.is_discounted THEN 0.5 ELSE 1.0 END) * vp.amount) AS total_cost
      FROM emoji e
      CROSS JOIN validated_params vp
      WHERE e.id = vp.emoji_id
        AND vp.amount > 0
        AND vp.amount <= 100
    ),
    deduct_funds AS (
      UPDATE "user" u
      SET points = u.points - te.total_cost
      FROM target_emoji te, validated_params vp
      WHERE u.id = vp.user_id AND u.points >= te.total_cost
      RETURNING u.id
    ),
    upsert_ownership AS (
      INSERT INTO stock_ownership (user_id, emoji_id, shares)
      SELECT vp.user_id, vp.emoji_id, vp.amount
      FROM validated_params vp
      WHERE EXISTS (SELECT 1 FROM deduct_funds)
      ON CONFLICT (user_id, emoji_id) DO UPDATE
      SET shares = stock_ownership.shares + EXCLUDED.shares
      RETURNING stock_ownership.emoji_id
    ),
    update_emoji AS (
      UPDATE emoji e
      SET
        current_price = GREATEST(0.01, e.current_price + (e.current_price * 0.01 * vp.amount)),
        trend = GREATEST(0.01, e.current_price + (e.current_price * 0.01 * vp.amount)) - e.current_price
      FROM validated_params vp
      WHERE e.id = vp.emoji_id AND EXISTS (SELECT 1 FROM deduct_funds)
      RETURNING e.id, e.current_price, e.trend
    )
    INSERT INTO price_history (id, emoji_id, price, recorded_at)
    SELECT gen_random_uuid(), ue.id, ue.current_price, NOW()
    FROM update_emoji ue;
    """
    params: [$emojiId, $amount, $isDiscounted, { _expr: "auth.uid" }]
  )
}

# Sell shares of an emoji stock
mutation SellStock($emojiId: UUID!, $amount: Int!) @auth(level: USER) {
  sellStock: _execute(
    sql: """
    WITH validated_params AS (
      SELECT
        $1::uuid AS emoji_id,
        $2::int AS amount,
        $3::text AS user_id
    ),
    target_emoji AS (
      SELECT
        e.id,
        (e.current_price * vp.amount) AS total_revenue,
        GREATEST(0.01, e.current_price * POWER(0.99, vp.amount)) AS new_price
      FROM emoji e
      CROSS JOIN validated_params vp
      WHERE e.id = vp.emoji_id
        AND vp.amount > 0
        AND vp.amount <= 100
    ),
    check_shares AS (
      SELECT so.user_id
      FROM stock_ownership so
      CROSS JOIN validated_params vp
      WHERE so.user_id = vp.user_id
        AND so.emoji_id = vp.emoji_id
        AND so.shares >= vp.amount
    ),
    add_funds AS (
      UPDATE "user" u
      SET points = u.points + te.total_revenue
      FROM target_emoji te, validated_params vp
      WHERE u.id = vp.user_id AND EXISTS (SELECT 1 FROM check_shares)
      RETURNING u.id
    ),
    update_ownership AS (
      UPDATE stock_ownership so
      SET shares = so.shares - vp.amount
      FROM validated_params vp
      WHERE so.user_id = vp.user_id
        AND so.emoji_id = vp.emoji_id
        AND EXISTS (SELECT 1 FROM check_shares)
        AND EXISTS (SELECT 1 FROM add_funds)
    ),
    update_emoji AS (
      UPDATE emoji e
      SET
        current_price = te.new_price,
        trend = te.new_price - e.current_price
      FROM target_emoji te, validated_params vp
      WHERE e.id = vp.emoji_id
        AND EXISTS (SELECT 1 FROM check_shares)
        AND EXISTS (SELECT 1 FROM add_funds)
      RETURNING e.id, e.current_price, e.trend
    )
    INSERT INTO price_history (id, emoji_id, price, recorded_at)
    SELECT gen_random_uuid(), ue.id, ue.current_price, NOW()
    FROM update_emoji ue;
    """
    params: [$emojiId, $amount, { _expr: "auth.uid" }]
  )
}

Key Takeaways

  • _execute: Executes a Data Manipulation Language (DML) statement, such as UPDATE, INSERT, or DELETE.
  • Common Table Expressions (WITH): Each block in the CTE depends on the previous one. For example, add_funds will only execute if check_shares returns a result. This handles the complex conditions completely within Postgres.
  • Context Injection: { _expr: "auth.uid" } injects the authenticated user's ID into the query directly on the server, enforcing security.

Generate the SDK

Because you have defined new queries and mutations in your GraphQL files, you must run the SDK generator so your TypeScript frontend can call it.

Open your terminal and run:

firebase dataconnect:sdk:generate

Integrate Native SQL in the web app

  1. Native SQL returns a flexible JSON payload rather than a strictly typed object. Because of this, it's essential to manually validate the returned data shape in your client code to handle the dynamic response.
  2. Execute Trades: In lib/ExchangeService.tsx, we wrap the generated buyStock and sellStock SDKs. Notice how the return types buyResult and sellResult must be manually validated as arrays, because _execute returns dynamic JSON data based on your specific RETURNING clauses in the SQL strings.
  3. Replace the empty executeBuyStock and executeSellStock functions with your original complete code:
import { buyStock, sellStock, generateTradeHeadline, triggerEvent } from "@dataconnect/generated";
import { LogEventKey } from "./InspectorContext";

// Execute a stock purchase, validating limits and potentially generating an AI news headline for large trades
export const executeBuyStock = async (
  emoji: any,
  amount: number,
  isDiscounted: boolean,
  user: any,
  logEvent: (key: LogEventKey, params?: any) => void,
): Promise<void> => {
  const MAX_AMOUNT = 100;

  if (!Number.isInteger(amount) || amount <= 0 || amount > MAX_AMOUNT) {
    throw new Error(`Amount must be an integer between 1 and ${MAX_AMOUNT}.`);
  }
  const singleSharePrice = isDiscounted
    ? emoji.currentPrice * 0.5
    : emoji.currentPrice;
  const estimatedCost = singleSharePrice * amount;
  const estimatedImpact = emoji.currentPrice * 0.05 * amount;

  logEvent("BUY_STOCK_TRANSACTION", { amount, symbol: emoji.symbol });

  const response = await buyStock({
    emojiId: emoji.id,
    amount: amount,
    isDiscounted: isDiscounted,
  });

  const buyResult = response.data?.buyStock as any;

  if (
    !buyResult ||
    buyResult === 0 ||
    (Array.isArray(buyResult) && buyResult.length === 0)
  ) {
    throw new Error(
      "Transaction denied: Insufficient funds or price mismatch.",
    );
  }

  const actualCost = Array.isArray(buyResult)
    ? buyResult[0].actual_cost
    : estimatedCost;
  const actualImpact = Array.isArray(buyResult)
    ? buyResult[0].actual_impact
    : estimatedImpact;

// TODO: Optionally add a custom resolver to call AI to generate headline for this purchase
};

// Execute a stock sale, validating ownership and potentially generating an AI news headline for large trades
export const executeSellStock = async (
  emoji: any,
  amount: number,
  ownedShares: number,
  user: any,
  logEvent: (key: LogEventKey, params?: any) => void,
): Promise<void> => {
  const MAX_AMOUNT = 100;

  if (!Number.isInteger(amount) || amount <= 0 || amount > MAX_AMOUNT) {
    throw new Error(`Amount must be an integer between 1 and ${MAX_AMOUNT}.`);
  }
  if (amount > ownedShares) {
    throw new Error(
      "INSUFFICIENT SHARES: You cannot sell more shares than you own.",
    );
  }

  const estimatedRevenue = emoji.currentPrice * amount;
  const dropRatePerShare = 0.05;
  const targetPrice =
    emoji.currentPrice * Math.pow(1 - dropRatePerShare, amount);
  const estimatedImpact = Math.max(0.01, targetPrice) - emoji.currentPrice;

  logEvent("SELL_STOCK_TRANSACTION", { amount, symbol: emoji.symbol });

  const response = await sellStock({
    emojiId: emoji.id,
    amount: amount,
  });

  const sellResult = response.data?.sellStock as any;

  if (
    !sellResult ||
    sellResult === 0 ||
    (Array.isArray(sellResult) && sellResult.length === 0)
  ) {
    throw new Error("Transaction denied: Insufficient shares.");
  }

  const actualRevenue = Array.isArray(sellResult)
    ? sellResult[0].actual_revenue
    : estimatedRevenue;
  const actualImpact = Array.isArray(sellResult)
    ? sellResult[0].actual_impact
    : estimatedImpact;
// TODO: Optionally add a custom resolver to call AI to generate headline for this sale

};

Query Geospatial Data (Local Radar): In app/src/components/LocalRadar.tsx, we subscribe to the getTrendingEmojisNearMeRef query. The dynamic JSON array from the _select execution maps directly to the UI list, utilizing PostGIS's distance calculations.

import { subscribe } from "@firebase/data-connect";
import { getTrendingEmojisNearMeRef } from "@dataconnect/generated";

// ... inside the component
  useEffect(() => {
    if (!location) return;

    setIsLoadingTrends(true);

    // Subscribe to realtime updates for trending emojis within a 50km radius
    const unsub = subscribe(
      getTrendingEmojisNearMeRef({
        userLat: location.lat,
        userLng: location.lng,
        radiusMeters: 50000, // 50km
      }),
      (res) => {
        if (res.data) setLocalData(res.data);
        setIsLoadingTrends(false);
      },
      (err) => {
        console.error("Local Radar Realtime Error:", err);
        setIsLoadingTrends(false);
      },
    );

    return () => unsub();
  }, [location?.lat, location?.lng]);

Query Geospatial Data (Global Assets Map): In app/src/app/map/page.tsx (the Insights Page), we use Native SQL's complex window functions (RANK() OVER) to find the single most popular emoji for every city in the database.

import { subscribe } from "@firebase/data-connect";
import { getTopEmojisByCityRef, getTrendingEmojisNearMeRef, getUserProfileRef } from "@dataconnect/generated";

// ... inside the component
  useEffect(() => {
    // Subscribe to realtime updates for the authenticated user's profile and stock ownership
    const unsub = subscribe(getUserProfileRef(), (res) => {
      if (res.data) setProfileData(res.data);
    });
    return () => unsub();
  }, []);

  useEffect(() => {
    // Subscribe to realtime updates for top trending emojis partitioned by user city
    const unsub = subscribe(getTopEmojisByCityRef(), (res) => {
      if (res.data) setCityData(res.data);
    });
    return () => unsub();
  }, []);

  useEffect(() => {
    setRadarLoading(true);
    // Subscribe to realtime updates for trending emojis within a specified geographic radius
    const unsub = subscribe(
      getTrendingEmojisNearMeRef({
        userLat: coords.lat,
        userLng: coords.lng,
        radiusMeters: radiusKm * 1000,
      }),
      (res) => {
        if (res.data) setRadarData(res.data);
        setRadarLoading(false);
      },
    );
    return () => unsub();
  }, [coords.lat, coords.lng, radiusKm]);

See it in action

  1. In your browser, navigate to the Geo page from the top navigation bar.
  2. If your location is correctly set in your Profile, the Global Top Assets map will ping the GetTopEmojisByCity native query to drop pins on cities with high trade volumes.
  3. Click Scan Local Network. The Local Radar Scanner will ask for your browser's location and ping the GetTrendingEmojisNearMe native query, utilizing PostGIS to find the top assets specifically traded within 50km of your coordinates!
  4. Navigate to the Home page or Profile page and purchase some assets to see your balance deduct and the emoji price update automatically via your atomic _execute queries.

8. Realtime subscriptions and caching

In the previous section, we used the subscribe() method in our React components to fetch data. While that successfully retrieved the initial state, a true stock exchange needs to feel alive. If another user buys a massive amount of emoji stock, your screen should update instantly.

This is where Firebase SQL Connect's Realtime features come in.

What is Realtime and how does it work?

Realtime support allows your application to receive proactive notifications from the server whenever data your app is using has been updated.

Here is the underlying mechanism:

  1. Trigger (@refresh): You tell the SQL Connect backend which specific mutations should trigger a data refresh for a given query.
  2. Broadcast: When one of those mutations executes (e.g., someone runs BuyStock), the server proactively broadcasts a realtime notification to any connected clients listening to that query.
  3. Cache Update: When the notification arrives, the JS SDK treats it just like an ad-hoc query execution. The local cache is instantly updated with the new data.
  4. UI Reactivity: The SDK automatically fires the onNext callbacks for all active subscribers, causing your React state to update and your UI to re-render "in real time".

Add @refresh triggers to your queries

To enable this on the backend, we need to add the @refresh directive to our queries.

  1. Open dataconnect/friendly-exchange/queries.gql.
  2. Update your existing queries by attaching @refresh directives for every market-altering mutation. For example, update GetDashboardData and GetUserProfile:
# Get dashboard data including top emojis by price and recent market events
query GetDashboardData
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
)
@refresh(onMutationExecuted: { operation: "BuyStock" })
@refresh(onMutationExecuted: { operation: "SellStock" })
@refresh(onMutationExecuted: { operation: "TriggerEvent" })
@refresh(onMutationExecuted: { operation: "MarketMakerTrade" }) {
  emojis(orderBy: [{ currentPrice: DESC }]) {
    id
    symbol
    name
    description
    currentPrice
    trend
  }
  events(orderBy: [{ createdAt: DESC }], limit: 15) {
    id
    description
    impact
    createdAt
    user {
      username
      profileImage
    }
    emoji {
      symbol
    }
  }
}

# Get current authenticated user profile and their stock ownership using auth.uid
query GetUserProfile
@auth(level: USER)
@refresh(onMutationExecuted: { operation: "BuyStock" })
@refresh(onMutationExecuted: { operation: "SellStock" })
@refresh(onMutationExecuted: { operation: "UpdateUserLocation" })
@refresh(onMutationExecuted: { operation: "UpdateUserRole" }) {
  user(id_expr: "auth.uid") {
    points
    username
    profileImage
    role
    stockOwnerships_on_user {
      shares
      emoji {
        id
        symbol
        currentPrice
        name
      }
    }
    city
    latitude
    longitude
  }
}

Key Takeaways

  • @refresh(onMutationExecuted: ...): Instructs the server to re-evaluate this query and push new data to subscribers whenever the specified mutation occurs.

Generate the SDK

Because you have defined new queries and mutations in your GraphQL files, you must run the SDK generator so your TypeScript frontend can call it.

Open your terminal and run:

firebase dataconnect:sdk:generate

Handle Realtime Subscriptions in the Web App

We already laid the groundwork for this in the previous section by using the subscribe method. Let's look closer at how the generated SDK handles this in React.

If you open app/src/app/page.tsx (the Home page), you will see the useEffect hook managing the dashboard data:

import { subscribe } from "@firebase/data-connect";
import { getDashboardDataRef } from "@dataconnect/generated";

// ... inside the component
  useEffect(() => {
    const queryRef = getDashboardDataRef();

    // The subscribe function registers the QueryRef and callbacks
    const unsubscribe = subscribe(
      queryRef,
      (res) => {
        // onNext: Fires initially, AND whenever a @refresh trigger occurs
        if (res.data) setDashboardData(res.data);
        setIsDashboardLoading(false);
      },
      (err) => {
        // onError: Handles any server or permission errors
        console.error("Dashboard Realtime Error:", err);
        setIsDashboardLoading(false);
      }
    );

    // onComplete/Cleanup: Unregisters the callbacks when the component unmounts
    return () => unsubscribe();
  }, [user]);

Key Takeaways

  • subscribe(queryRef, onNext, onError): Enables Realtime notifications for the specific QueryRef.
  • unsubscribe(): Calling subscribe returns a cleanup function. It is critical to return this in your useEffect so that when the component unmounts (e.g., the user navigates away), the subscription is canceled and memory leaks are prevented.
  • Caching Efficiency: If multiple components subscribe to the same query (like GetDashboardData), the SDK shares the cached result. When a Realtime notification arrives, the cache updates once, and all active subscribers are notified automatically.

See it in action

Because you've added @refresh to your backend and subscribe to your frontend, your app is now fully reactive.

  1. Open your web app in two separate browser windows side-by-side.
  2. In one window, purchase a few shares of an emoji.
  3. Watch the second window—without refreshing the page, you will instantly see the emoji's price increase!

9. Conclusion

Congratulations, you've successfully built and deployed a realtime, highly complex trading platform directly on top of PostgreSQL using Firebase SQL Connect!

By utilizing SQL Connect, you were able to:

  • Define a strictly-typed GraphQL schema that maps directly to PostgreSQL.
  • Enforce granular, row-level security using Firebase Authentication and @auth directives.
  • Leverage advanced Native SQL to query geospatial data with PostGIS and write atomic market transactions via CTEs.
  • Make your entire application reactive using the @refresh directive for realtime subscriptions.
  • Seamlessly generate frontend SDKs to keep your client code synced with your database.

If you want to play with your own market data, feel free to insert your own mock emojis, locations, and pricing histories using the Firebase SQL Connect extension by mimicking the .gql seed files, or add them through the SQL Connect execution pane in VS Code.

10. Deploy to Cloud

Now that you've worked through the local development iteration, it's time to deploy your schema, data, and queries to the server. This can be done using the Firebase SQL Connect VS Code extension or the Firebase CLI.

Set up Firebase Authentication in your Firebase project

  1. Set up Firebase Authentication with Google Sign-In.
  2. (Optional) Allow domains for Firebase Authentication using the Firebase console (for example, http://127.0.0.1).
    1. In the Authentication settings, go to Authorized Domains.
    2. Click "Add Domain" and include your local domain in the list.

Enable required PostgreSQL Extensions

Because this app utilizes PostgreSQL extensions for vector search and location tracking, you must manually enable them on your provisioned Cloud SQL instance before deploying your schema.

  1. Navigate to the Google Cloud Console.
  2. Go to Cloud SQL -> select your provisioned instance -> click Cloud SQL Studio.
  3. Log into your database and execute the following commands:
# Required for the Geo Map page
CREATE EXTENSION IF NOT EXISTS postgis;
# Required for Vector Search
CREATE EXTENSION IF NOT EXISTS "vector";
# Required for automatic Vector Search embedding generation
CREATE EXTENSION IF NOT EXISTS "google_ml_integration";

Build your web app for hosting

Back in VS Code, ensure you have placed your firebaseConfig variables in lib/firebase.tsx (as done in the setup section).

Next, guarantee that your frontend is using the latest generated hooks by running:

firebase dataconnect:sdk:generate

Then, build the React web app for hosting deployment:

npm run build

Deploy with the Firebase CLI

In dataconnect/dataconnect.yaml, ensure that your instance ID, database, and service ID match your actual Google Cloud project identifiers, and use the v1 specification:

specVersion: v1
serviceId: your-project-id-service
location: us-west4
schemas:
  - source: ./schema
    datasource:
      postgresql:
        database: your-project-id-database
        cloudSql:
          instanceId: your-project-id-instance
connectorDirs:
  - ./friendly-exchange

In your terminal, run the following command to deploy:

firebase deploy --only dataconnect,hosting

For updates or refactors, run this command to compare your schema changes:

firebase dataconnect:sql:diff

If the changes are acceptable, apply them with:

firebase dataconnect:sql:migrate

Your Cloud SQL for PostgreSQL instance will be updated with the final deployed schema and data. You should now be able to see your app live at your-project.web.app/.

Learn more

11. Optional: Vector search with Firebase SQL Connect (billing required)

In this section, you'll enable vector search in your emoji exchange using Firebase SQL Connect. This feature allows for semantic, content-based searches, such as finding emojis that match a vibe or concept using vector embeddings.

This step requires that you completed the last step of this codelab to deploy to Google Cloud.

Update the schema to include embeddings for a field

In dataconnect/schema/schema.gql, add the descriptionEmbedding field to your Emoji table. Replace your existing Emoji type with this updated version:

# Emojis
# emoji-stockOwnership is a one-to-many relationship, emoji-priceHistory is a one-to-many relationship
# Implements @searchable directives for full-text search
# Optional: implements Vector type for semantic search
type Emoji @table {
  id: UUID! @default(expr: "uuidV4()")
  symbol: String!
  name: String! @searchable
  tags: [String!]
  description: String! @searchable
  descriptionEmbedding: Vector @col(size: 768)
  currentPrice: Float! @default(value: 10.0)
  trend: Float! @default(value: 0.0)
}

Key Takeaways

  • descriptionEmbedding: Vector @col(size: 768): This field stores the semantic embeddings of your emoji descriptions, enabling vector-based content search in your app.

Add a vector search query

In dataconnect/friendly-exchange/queries.gql, add the following query to perform vector searches:

# Search emoji descriptions using Vertex AI embeddings
query VectorSearchEmojis($query: String!)
@auth(
  level: PUBLIC
  insecureReason: "This operation is safe to expose to the public."
)
@refresh(onMutationExecuted: { operation: "BuyStock" })
@refresh(onMutationExecuted: { operation: "SellStock" })
@refresh(onMutationExecuted: { operation: "TriggerEvent" })
@refresh(onMutationExecuted: { operation: "MarketMakerTrade" }) {
  emojis_descriptionEmbedding_similarity(
    compare_embed: { model: "text-multilingual-embedding-002", text: $query }
    method: COSINE
    within: 2
    limit: 15
  ) {
    id
    symbol
    name
    description
    currentPrice
    trend
    _metadata {
      distance
    }
  }
}

Key Takeaways:

  • compare_embed: Specifies the embedding model (text-multilingual-embedding-002) and the input text ($query) for comparison.
  • method: Specifies the similarity method (COSINE), measuring the cosine similarity between the vectors.
  • within: Limits the search to emojis with a distance of 2 or less, focusing on close content matches.

Generate the SDK

Because you have defined new queries and mutations in your GraphQL files, you must run the SDK generator so your TypeScript frontend can call it.

Open your terminal and run:

firebase dataconnect:sdk:generate

Activate Vertex AI and re-deploy

  1. Follow the prerequisites guide to set up Vertex AI APIs from Google Cloud. This step is essential to support the embedding generation.
  2. Re-deploy your schema to activate pgvector and vector search by running firebase deploy --only dataconnect or clicking "Deploy to Production" using the Firebase SQL Connect VS Code extension.

Populate the database with embeddings

  1. Open the dataconnect folder in VS Code.
  2. Click Run (Production) in optional_vector_seed.gql to populate your deployed database with the 768-dimensional embeddings for the emojis.

Implement the vector search function in your app

Now that the schema and query are set up, integrate the vector search into your app's frontend.

In app/src/app/page.tsx (your Home component), review the useEffect that listens to the search input and swaps dynamically between full-text search and vector search based on the user's selected searchMode:

import { subscribe } from "@firebase/data-connect";
import {
  getDashboardDataRef,
  searchEmojisRef,
  vectorSearchEmojisRef, // <-- Add this!
  getChronologicalTickerRef,
  getUserProfileRef,
} from "@dataconnect/generated";

// Inside Home component, find the search useeffect
useEffect(() => {
    if (!debouncedSearch) {
      setSearchData(null);
      return;
    }

    let unsubscribe: () => void;

    if (searchMode === "TEXT") {
      // Subscribe to realtime full-text search results for emojis based on user input
      unsubscribe = subscribe(
        searchEmojisRef({ query: debouncedSearch }),
        (res) => {
          if (res.data) setSearchData(res.data.emojis_search);
          setIsSearchLoading(false);
        },
        (err) => {
          console.error("Text Search Error:", err);
          setIsSearchLoading(false);
        },
      );
    } else {
      // Subscribe to realtime vector search results using semantic similarity for emojis based on user input
      unsubscribe = subscribe(
        vectorSearchEmojisRef({ query: debouncedSearch }),
        (res) => {
          if (res.data)
            setSearchData(res.data.emojis_descriptionEmbedding_similarity);
          setIsSearchLoading(false);
        },
        (err) => {
          console.error("Vector Search Error:", err);
          setIsSearchLoading(false);
        },
      );
    }

    return () => {
      if (unsubscribe) unsubscribe();
    };
  }, [debouncedSearch, searchMode]);

See it in action

Navigate to the search bar on your app's homepage. Type in abstract phrases like "happy", "nature", or "technology". Toggle the search mode from TEXT to VECTOR and notice how the results shift from exact string matches to contextual, semantic matches returned directly from Vertex AI and PostgreSQL!

12. Optional: Custom Resolvers with Vertex AI (billing required)

10:00

By writing Custom Resolvers, you can extend Firebase SQL Connect to support other data sources and combine them into your unified GraphQL schema. In this section, you'll write a Firebase Cloud Function that uses Vertex AI (Gemini) to generate a satirical financial news headline whenever a user makes a large trade, and expose that function through SQL Connect.

Initialize the custom resolver

Instead of creating all the boilerplate files manually, the Firebase CLI has a built-in generator for custom resolvers.

Open your terminal in the root of your project and run:

firebase init dataconnect:resolver

When prompted by the CLI:

  1. Enter generateTradeHeadline as the name for your custom resolver.
  2. Select TypeScript to generate the example implementation.

The CLI will automatically create a new dataconnect/schema_generateTradeHeadline/schema.gql file, initialize a functions directory with sample code, and link the resolver in your dataconnect.yaml configuration!

Define the custom resolver schema

Next, you need to define the exact shape of your custom endpoint using a GraphQL schema.

Open the newly generated dataconnect/schema_generateTradeHeadline/schema.gql file and replace its contents with the following code:

# Custom resolver fields can be defined on root Query and Mutation types.
type Mutation {
  # This field will be backed by your Cloud Function.
  generateTradeHeadline(
    emojiSymbol: String!
    emojiName: String!
    username: String!
    tradeAmount: Int!
    tradeCost: Float!
    tradeType: String!
  ): String!
}

Key Takeaways:

  • By placing this inside the root type Mutation, you are telling SQL Connect that this operation might have side-effects (like calling an AI API) rather than just reading data.

Implement the custom resolver logic

Next, implement your resolver using Cloud Functions. Under the hood, you are creating a GraphQL server; however, Cloud Functions provides a helper method, onGraphRequest, that handles the boilerplate so you only need to write the core logic.

Open your Firebase Functions file (functions/src/index.ts), which the CLI generated for you. Replace the entire file with the Gemini API implementation:

import { setGlobalOptions } from "firebase-functions";
import {
  FirebaseContext,
  onGraphRequest,
} from "firebase-functions/dataconnect/graphql";
import { initializeApp, getApps } from "firebase-admin/app";
import { GoogleGenAI } from "@google/genai";

setGlobalOptions({
  maxInstances: 10,
  region: "us-west4",
});

if (getApps().length === 0) {
  initializeApp();
}

const ai = new GoogleGenAI({
  vertexai: true,
  project: process.env.GCLOUD_PROJECT || "your-project-id",
  location: process.env.GCLOUD_LOCATION || "us-west4",
});

const headlineOpts = {
  // Points to the schema you defined earlier
  schemaFilePath: "dataconnect/schema_generateTradeHeadline/schema.gql",
  resolvers: {
    mutation: {
      // Generate a satirical financial news headline for a stock trade using Vertex AI
      async generateTradeHeadline(
        _parent: unknown,
        args: Record<string, unknown>,
        _contextValue: FirebaseContext,
        _info: unknown,
      ): Promise<string> {
        const {
          emojiSymbol,
          emojiName,
          username,
          tradeAmount,
          tradeCost,
          tradeType,
        } = args;

        try {
          const prompt = `You are a hype-driven, satirical financial news bot. 
          A user named '${username}' just executed a massive ${tradeType} of ${tradeAmount} shares of ${emojiSymbol} (${emojiName}) for $${tradeCost}. 
          Write a single, punchy, dramatic news headline (under 12 words) about this market move, use puns wherever possible, but don't round or exagerate the numbers. Include the asset symbol.`;
          
          const response = await ai.models.generateContent({
            model: "gemini-2.5-flash-lite",
            contents: prompt,
          });

          if (!response.text) {
            throw new Error("No text returned from Vertex AI");
          }

          return response.text.trim();
        } catch (error) {
          console.error("Vertex AI generation failed:", error);
          return `BREAKING: Massive ${tradeType} detected on ${emojiSymbol}! Market reacting.`;
        }
      },
    },
  },
};

export const generateTradeHeadline = onGraphRequest(headlineOpts);

สิ่งสำคัญที่ได้เรียนรู้

  • onGraphRequest: Wrapper ของฟังก์ชันของ Firebase ที่มีความเฉพาะเจาะจงซึ่งแมป Cloud Function กับสคีมาตัวแก้ไขที่กำหนดเองของ SQL Connect
  • args: ระบบจะพิมพ์และดึงอาร์กิวเมนต์ที่ส่งจากการกลายพันธุ์ของ GraphQL โดยอัตโนมัติที่นี่เพื่อแทรกลงในพรอมต์ Gemini

เพิ่มการเปลี่ยนแปลงลงในตัวเชื่อมต่อ

เมื่อมีตรรกะตัวแก้ไขที่กำหนดเองแล้ว ให้เปิดเผยผ่านเครื่องมือเชื่อมต่อของแอปพลิเคชันเพื่อให้ส่วนหน้าเรียกใช้ได้

เปิด dataconnect/friendly-exchange/mutations.gql แล้วเพิ่มการเปลี่ยนแปลงต่อไปนี้

# Generate an AI headline for a stock trade
mutation GenerateTradeHeadline(
  $emojiSymbol: String!
  $emojiName: String!
  $username: String!
  $tradeAmount: Int!
  $tradeCost: Float!
  $tradeType: String!
)
@auth(
  level: USER
  insecureReason: "This operation is safe to expose to any authenticated user."
) {
  aiHeadline: generateTradeHeadline(
    emojiSymbol: $emojiSymbol
    emojiName: $emojiName
    username: $username
    tradeAmount: $tradeAmount
    tradeCost: $tradeCost
    tradeType: $tradeType
  )
}

ติดตั้งใช้งานและสร้าง SDK

เนื่องจากตัวแก้ไขที่กำหนดเองทำงานผ่าน Cloud Functions คุณจึงต้องทำให้ฟังก์ชันใช้งานได้ใน Google Cloud เพื่อให้ปลายทางทำงาน

เปิดเทอร์มินัลและทำให้ฟังก์ชันใช้งานได้โดยทำดังนี้

firebase deploy --only functions

เมื่อทำให้ใช้งานได้แล้ว ให้สร้าง SDK ส่วนหน้าเพื่อรวมการเปลี่ยนแปลง AI ใหม่

firebase dataconnect:sdk:generate

ผสานรวมตัวแก้ไข AI ในเว็บแอป

มาตั้งค่าให้ระบบส่งการแจ้งเตือนข่าวด่วนเมื่อมีการซื้อขายหุ้นตั้งแต่ 10 หุ้นขึ้นไปกัน

เปิด lib/ExchangeService.tsx ก่อนอื่น ตรวจสอบว่าคุณได้นำเข้า generateTradeHeadline และ triggerEvent ที่ด้านบนแล้ว

import { 
  buyStock, 
  sellStock, 
  generateTradeHeadline, 
  triggerEvent 
} from "@dataconnect/generated";

จากนั้นเลื่อนลงไปที่ด้านล่างของexecuteBuyStockฟังก์ชัน แล้วแทนที่ TODO ด้วยบล็อกทริกเกอร์ AI ก่อนที่ฟังก์ชันจะสิ้นสุด

// ... (existing executeBuyStock code)

  const actualImpact = Array.isArray(buyResult)
    ? buyResult[0].actual_impact
    : estimatedImpact;

  if (amount >= 10 && user) {
    setTimeout(() => {
      logEvent("GENERATE_HEADLINE_RESOLVER");
    }, 2000);

    const headlineResult = await generateTradeHeadline({
      emojiSymbol: emoji.symbol,
      emojiName: emoji.name,
      username: user.displayName || "Anonymous Whale",
      tradeAmount: amount,
      tradeCost: actualCost.toFixed(2),
      tradeType: "BUY",
    });

    await triggerEvent({
      emojiId: emoji.id,
      impact: actualImpact.toFixed(2),
      description: `GEMINI REPORT: ${headlineResult.data?.aiHeadline}`,
      now: new Date().toISOString(),
    });
  }
};

ทำแบบเดียวกันที่ด้านล่างของฟังก์ชัน executeSellStock

// ... (existing executeSellStock code)

  const actualImpact = Array.isArray(sellResult)
    ? sellResult[0].actual_impact
    : estimatedImpact;

  if (amount >= 10 && user) {
    const headlineResult = await generateTradeHeadline({
      emojiSymbol: emoji.symbol,
      emojiName: emoji.name,
      username: user.displayName || "Anonymous Whale",
      tradeAmount: amount,
      tradeCost: actualRevenue.toFixed(2),
      tradeType: "SELL",
    });

    await triggerEvent({
      emojiId: emoji.id,
      impact: actualImpact.toFixed(2),
      description: `GEMINI REPORT: ${headlineResult.data?.aiHeadline}`,
      now: new Date().toISOString(),
    });
  }
};

ดูของจริง

  1. โหลดเว็บแอปซ้ำ
  2. ตรวจสอบว่าคุณได้ลงชื่อเข้าใช้และมีสกุลเงินเพียงพอ
  3. เลือกอีโมจิและซื้อการแชร์อย่างน้อย 10 รายการพร้อมกัน
  4. ดูแถบเลื่อนตลาดโลกทางด้านขวาของแดชบอร์ด ภายในไม่กี่วินาที คุณจะเห็นพาดหัวข่าวเสียดสีที่กำหนดเองซึ่ง Gemini สร้างขึ้น