Database 類別 參考文件

指向資料庫的連接物件，本類別適用於須存取多個 Table 時方便建立連線之用。 更多...

公開方法(Public Methods)
操作
Table	getTable (@NonNull String table)
	取得資料表連結器。 更多...
String []	getTableNames () throws IOException
	取得資料庫中的所有資料表的名稱。 更多...
Table []	getTables () throws IOException
	取得資料庫中的所有資料表。 更多...

建構子
	Database (@NonNull String apiRoot)
	建立一個不帶授權的 Database 實體。 更多...
	Database (@NonNull String apiRoot, @NonNull String username, @NonNull String password)
	建立一個帶授權的 Database 實體。 更多...

詳細描述

指向資料庫的連接物件，本類別適用於須存取多個 Table 時方便建立連線之用。

在一般使用情境下，Database 並非必須建立的物件，唯當要自同一個資料庫建立多組 Table 時候， 可利用 Database#getTable(String) 方法減少寫死參數的使用， 或利用 Database#getTables() 可進行查詢並取得所有的資料表物件。如：

Database db = new Database("www.example.com:8000", "user", "passw0rd");
Table[] tables = db.getTables();

本架構設計上係以適應Django rest-framework為主，但並不做檢查，期望能適應多數restful api標準。

備註

建立 Database 實體(instance)時候並不會建立網路連線。

建構子與解構子說明文件

Database() [1/2]

Database

(

@NonNull String

apiRoot

)

建立一個不帶授權的 Database 實體。

注意

基於安全性因素，單一裝置上高頻率地進行操作會觸發 CSRF protection 保護機制。 對於需要頻繁進行操作的資料表，請考慮使用 Database#Database(String, String, String)。

參數

apiRoot

api root所在位置，須包含傳輸阜，如：http://example:8000/api/

Database() [2/2]

Database	(	@NonNull String	apiRoot,
		@NonNull String	username,
		@NonNull String	password
	)

建立一個帶授權的 Database 實體。

參數

apiRoot	api root所在位置，須包含傳輸阜，如：http://example:8000/api/
username	登入所使用的使用者名稱
password	登入所使用的密碼

函式成員說明文件

getTable()

Table getTable

(

@NonNull String

table

)

取得資料表連結器。

此函式不會使用網路連線，僅以參數疊加方式建立連結接口。

參數

table

資料表名

傳回值

資料表連節器

getTableNames()

String [] getTableNames

(

)

throws IOException

取得資料庫中的所有資料表的名稱。

備註

此函式會使用網路連線。

傳回值

此資料庫下所有的資料表的名稱

例外

IOException	資料庫不存在，或網路錯誤
NetworkOnMainThreadException	在主執行緒上使用此函式

getTables()

Table [] getTables

(

)

throws IOException

取得資料庫中的所有資料表。

備註

此函式會使用網路連線。

傳回值

此資料庫下所有的資料表的 Table

例外

IOException	資料庫不存在，或網路錯誤
NetworkOnMainThreadException	在主執行緒上使用此函式

---

此類別(class) 文件是由下列檔案中產生:

• lib/src/main/java/nctu/fintech/appmate/Database.java