{%hackmd @wh91008/theme %}

# Lecture 1 - 使用Python建置Firestore

###### tags: `GCP` `Firestore` `Python`

[TOC]

---
## ==一、簡介==
簡單來說， Cloud Firestore 是一個快速、完全託管的檔案導向 NoSQL 資料庫。不像 SQL 資料庫有 table、rows，Cloud Firestore 的資料都是存在檔案 (document)，而這些檔案則是以資料夾 (collection)。每個檔案是以 key-value 做儲存資料的格式。
:::warning
:bulb: 小提醒：NoSQL 是 "Not only SQL" 的意思，也就是可以做到 **"不只是個資料庫"** 的功能
:::
###### :book: 參考資料： https://blog.gcp.expert/cloud-firestore-cloud-native-nosql-introduction/

---
## ==二、前置作業==
需先於cmd執行下列指令

- <code color=red>pip install python-firebase</code>
- <code>pip install firebase-admin</code>

:::warning
:bulb: 小提醒：
若在cmd內輸入上述指令後顯示「'pip' 不是內部或外部命令、可執行的程式或批次檔。」
可參考 [不錯的教學](http://alex9ufoexploer.blogspot.com/2017/10/python-pip.html)
:::

---
## ==三、專案設置==
### 步驟一：建立專案

### 步驟二：建立資料庫
分為「鎖定模式」與「測試模式」：
- 「鎖定模式」：系統會拒絕所有第三方的讀寫作業
- 「測試模式」：可以使用第三方程序來進行所有讀寫作業


不論選擇哪一種，後續都能於 **Database->規則** 處更改權限為```true```或```false```

### 步驟三：設置私密金鑰
此步驟主要是供 **本機端** 使用，如果沒有獲得金鑰就不能對從本機端透過 Python、JavaScript...等程式語言來對 firestore 的資料做更改。
:::warning
:bulb: 小提醒：如果後續要使用到 Cloud Function 的話則不需要此步驟，初學者的話還是建議先從 **本機端** 來做練習。（關於 Cloud Function 的資訊可參考 [第五章 - Cloud Function的入門與部署](https://hackmd.io/yn10QCzJS8yqbe8twZGCFQ)）

:::

首先於左上角齒輪處點選專案設定，選擇服務帳戶後，將箭頭勾至Python，並按下產生新的私密金鑰，流程整理如下：
- 齒輪->專案設定->服務帳戶->勾選Python->產生私密金鑰

- 複製程式碼，貼至Python習慣的IDE中，並更改cred中的路徑

### 步驟四：集合與文件
主要可分為：
- <code>set()</code>：新增
- <code>update()</code>：修改
- <code>get()</code>：查詢
- <code>delete()</code>：刪除
:::warning
:bulb: 小提醒：```set()``` 與 ```update()``` 的差異在於，如果更改資料用 ```set()``` ，則全部欄位與資訊都要列上去， ```update()``` 可直接針對裡面某個欄位的值下去修改
:::

以下將直接舉例，除了一、新增為完整的程式碼外（涵蓋設置金鑰和建立集合與文件部分），後面三者為補充的程式碼

---
## ==四、Firestore 資料更改基礎==
### （一）新增

#####################一定需要，且一段程式碼只能出現一次####################
import firebase_admin
# 用來認證
from firebase_admin import credentials
# path/to/serviceAccount.json 須改為自己的金鑰路徑
cred = credentials.Certificate("path/to/serviceAccount.json")
firebase_admin.initialize_app(cred)

# 用來存放資料
from firebase_admin import firestore
db = firestore.client()

########################################################################
# collectio為集合，document為要寫入的文件
student1 = db.collection('Q1').document('DOC2')
student1.set({
    '姓名': '西野',
    '年齡': '23',
    '學號': '123456789'
})

# 用來提醒自己已經新增好資料
print('Done')

打開firebase，就能看到自己剛剛建立的資料

:::warning

:bulb:小提醒
- 第11列程式碼如果打

<code> student1 = db.collection('Q1',"DOC1","Q2").document('DOC2')</code>

就是在「集合Q1」內的「DOC1文件」中的「集合Q2」中的「DOC2文件」中新增資料，也就代表使用者可以自己製造階層來存放資料，就像「資料夾中的資料夾」一樣。
- 也可寫為 ```student1 = db.collection("Q1/DOC1/Q2").document('DOC2')``` 或 ```student1 = db.document("Q1/DOC1/Q2/DOC2")```
- 若15列程式碼改為 <code>student1 = db.collection('Q1').document()</code> ，則不限定有幾份document，也就是每次執行，系統都會幫忙產生一個隨機名稱的dcoument，很方便，很適合用在迴圈，執行多次後的結果如下圖
:::

### （二）修改

# Update Document
student1.update({
    '年齡': '24'
})

即得到下圖（年齡變為24）：

### （三）查詢
id為文件名稱，to_dict()為裡面的內容

# Get Collection
get_collection = db.collection("Q1").get()
for doc in get_collection:
    print(u'{} => {}'.format(doc.id, doc.to_dict()))

# Get Doc
get_doc = db.collection('Q1').document('DOC2').get()
# 若要查詢student1文件，則可以直接改為get_doc = student1.get()
print('姓名 => {}'.format(doc.to_dict()['姓名']))
print('學號 => {}'.format(doc.to_dict()['學號']))
print('年齡 => {}'.format(doc.to_dict()['年齡']))

即得到下圖執行結果：

### （四）刪除
在此先隨意創建相同路徑之第二份文件

先使用 ```get()``` 獲取 collection 或 doc 的資料，再以迴圈刪除
（因為同一個文件裡可能有好幾筆資料同時有某個值，所以才要用迴圈）
:::danger
:exclamation: 2019 年年底使用 `db.collection("Q1").get()` 已經無效，要更改為 `db.collection("Q1").stream()`
:::

# Get Collection
get_collection = db.collection("Q1").get()
    
# Delete Collection
for delete_list in get_collection:
    doc_del = db.collection('Q1').document(delete_list.id)
    doc_del.delete() # 刪除document
    print('Delete Doc: {} Complete.'.format(delete_list.id))

即得到下圖結果：
（Q1集合的所有文件遭刪除，因為Q1內不再有文件，所以連Q1都消失）

若路徑不相同，則文件則不會被刪除：
（DOC1的創建路徑為<code class=blue>db.collection('Q1', 'DOC1', 'Q2').document('DOC2')</code>）

:::warning
:bulb:小提醒：程式碼為方便教學都打<code>student1 = db.collection('Q1').document('DOC2')</code>，
但其實建議改為<code>student1_ref = db.collection('Q1').document('DOC2')</code>，來代表參照位置
例如查詢資料，就打<code>student1_ref.get()</code>即可。
:::

###### :book: 參考資料：
###### 1. https://medium.com/pyradise/10%E5%88%86%E9%90%98%E8%B3%87%E6%96%99%E5%BA%AB%E6%93%8D%E4%BD%9C-%E6%96%B0%E5%A2%9E%E8%B3%87%E6%96%99-b96db385e1e4
###### 2. https://mks.tw/2675/%E3%80%8C%E5%AD%B8%E7%BF%92%E6%97%A5%E8%AA%8C%E3%80%8Dcloud-firestore-%E5%9F%BA%E6%9C%AC%E6%96%B0%E5%A2%9E%E3%80%81%E6%9F%A5%E8%A9%A2%E3%80%81%E5%88%AA%E9%99%A4%E5%88%9D%E9%AB%94%E9%A9%97-python