Veri Alma

GET ile Verileri Okuma

URL uç noktasına GET isteği göndererek Firebase veritabanımızdaki verileri okuyabiliriz. Önceki bölümdeki blog örneğimize devam edelim ve tüm blog yayını verilerini okuyalım:

curl 'https://docs-examples.firebaseio.com/fireblog/posts.json?print=pretty'

Başarılı bir istek, 200 OK HTTP durum koduyla belirtilir ve yanıt, aldığımız verileri içerir.

URI parametreleri ekleme

REST API, Firebase veritabanımızdan veri okurken çeşitli sorgu parametrelerini kabul eder. En sık kullanılan parametreler aşağıda listelenmiştir. Tam liste için REST API Referansı'na bakın.

auth

auth istek parametresi, Firebase Realtime Database Security Rules ile korunan verilere erişmenize olanak tanır ve tüm istek türleri tarafından desteklenir. Parametre, Firebase Projelerindeki Kullanıcılar bölümünde açıklandığı gibi Firebase uygulamanızın gizlisi veya kimlik doğrulama jetonu olabilir. Aşağıdaki örnekte, CREDENTIAL'nin Firebase uygulamanızın gizlisi veya kimlik doğrulama jetonu olduğu bir auth parametresi içeren bir GET isteği gönderiyoruz:

curl 'https://docs-examples.firebaseio.com/auth-example.json?auth=CREDENTIAL'

yazdır

print=pretty belirtildiğinde veriler kullanıcıların okuyabileceği bir biçimde döndürülür.

curl 'https://docs-examples.firebaseio.com/fireblog/posts.json?print=pretty'

print=silent belirtildiğinde, başarılı olduğunda 204 No Content döndürülür.

curl 'https://docs-examples.firebaseio.com/fireblog/posts.json?print=silent'

geri çağırma

Web tarayıcısında farklı alan adları arasında REST çağrıları yapmak için yanıtı bir JavaScript geri çağırma işlevine sarmalamak üzere JSONP'yi kullanabilirsiniz. REST API'nin döndürülen verileri belirttiğiniz geri çağırma işlevine sarmalaması için callback= ekleyin. Örneğin:

<script>
  function gotData(data) {
    console.log(data);
  }
</script>
<script src="https://docs-examples.firebaseio.com/fireblog/posts.json?callback=gotData">

sığ

Bu, her şeyi indirmenize gerek kalmadan büyük veri kümeleriyle çalışmanıza yardımcı olmak için tasarlanmış gelişmiş bir özelliktir. Bu özelliği kullanmak için parametre olarak shallow=true ekleyin. Bu, döndürülen verilerin derinliğini sınırlandırır. Konumdaki veriler JSON ilkel (dize, sayı veya boole) ise değeri döndürülür. Konumdaki veri anlık görüntüsü bir JSON nesnesiyse her anahtarın değerleri true olarak kısaltılır. Örneğin, aşağıdaki verileri kullanarak:

{
  "message": {
    "user": {
      "name": "Chris"
    },
    "body": "Hello!"
  }
}

// A request to /message.json?shallow=true
// would return the following:
{
  "user": true,
  "body": true
}

// A request to /message/body.json?shallow=true
// would simply return:
"Hello!"

Bu curl isteğiyle deneyebilirsiniz:

curl 'https://docs-examples.firebaseio.com/rest/retrieving-data.json?shallow=true&print=pretty'

zaman aşımı

Sunucu tarafında okuma işleminin ne kadar süreceğini sınırlamak için bunu kullanın. Bir okuma isteği, ayrılan süre içinde tamamlanmazsa HTTP 400 hatasıyla sonlandırılır. Bu seçenek, özellikle küçük bir veri aktarımı beklediğinizde ve büyük olabilecek bir alt ağacı almak için çok uzun süre beklemek istemediğinizde yararlıdır. Gerçek okuma süresi, veri boyutuna ve önbelleğe almaya bağlı olarak değişebilir.

timeouts değerini şu biçimi kullanarak belirtin: 3ms, 3s veya 3min, sayı ve birim içerecek şekilde. Belirtilmezse 15min için maksimum timeout değeri uygulanır. timeout pozitif değilse veya maksimum değeri aşıyorsa istek, HTTP 400 hatasıyla reddedilir. Aşağıdaki örnekte, GET isteği 10 saniyelik bir timeout içeriyor.

curl 'https://docs-examples.firebaseio.com/rest/retrieving-data.json?timeout=10s'

Verileri filtreleme

Verileri çeşitli faktörlere göre filtrelemek için sorgular oluşturabiliriz. Başlamak için orderBy parametresini kullanarak verilerinizin nasıl filtrelenmesini istediğinizi belirtirsiniz. Ardından orderBy'ü diğer beş parametreden herhangi biriyle birleştirirsiniz: limitToFirst, limitToLast, startAt, endAt ve equalTo.

Firebase'de hepimiz dinozorları çok sevdiğimiz için verileri nasıl filtreleyebileceğinizi göstermek amacıyla dinozorlarla ilgili bilgiler içeren örnek bir veritabanından bir snippet kullanacağız:

{
  "lambeosaurus": {
    "height": 2.1,
    "length": 12.5,
    "weight": 5000
  },
  "stegosaurus": {
    "height": 4,
    "length": 9,
    "weight": 2500
  }
}

Verileri üç şekilde filtreleyebiliriz: alt anahtara, anahtara veya değere göre. Sorgu bu parametrelerden biriyle başlar ve ardından aşağıdaki parametrelerden biriyle veya daha fazlasıyla birleştirilmelidir: startAt, endAt, limitToFirst, limitToLast veya equalTo.

Belirtilen bir alt öğe anahtarına göre filtreleme

Nodları ortak bir alt anahtara göre filtrelemek için bu anahtarı orderBy parametresine iletebiliriz. Örneğin, yüksekliği 3'ten büyük olan tüm dinozorları almak için şunları yapabiliriz:

curl 'https://dinosaur-facts.firebaseio.com/dinosaurs.json?orderBy="height"&startAt=3&print=pretty'

Filtre uyguladığımız alt anahtara sahip olmayan tüm düğümler, null değerine göre sıralanır. Verilerin nasıl sıralandığıyla ilgili ayrıntılı bilgi için Verilerin Sıralama Yöntemi başlıklı makaleyi inceleyin.

Firebase, yalnızca bir düzey aşağıda olan alt öğeler yerine derin iç içe yerleştirilmiş alt öğelere göre sıralanmış sorguları da destekler. Bu, aşağıdaki gibi derin iç içe yerleştirilmiş verileriniz varsa kullanışlıdır:

{
  "lambeosaurus": {
    "dimensions": {
      "height" : 2.1,
      "length" : 12.5,
      "weight": 5000
    }
  },
  "stegosaurus": {
    "dimensions": {
      "height" : 4,
      "length" : 9,
      "weight" : 2500
    }
  }
}

Artık yüksekliği sorgulamak için tek bir anahtar yerine nesnenin tam yolunu kullanıyoruz:

curl 'https://dinosaur-facts.firebaseio.com/dinosaurs.json?orderBy="dimensions/height"&startAt=3&print=pretty'

Sorgular aynı anda yalnızca bir anahtara göre filtrelenebilir. orderBy parametresinin aynı istekte birden fazla kez kullanılması hataya yol açar.

Anahtara göre filtreleme

orderBy="$key" parametresini kullanarak düğümleri anahtarlarına göre de filtreleyebiliriz. Aşağıdaki örnekte, adları a ile m arasında bir harfle başlayan tüm dinozorlar getirilmektedir:

curl 'https://dinosaur-facts.firebaseio.com/dinosaurs.json?orderBy="$key"&startAt="a"&endAt="m"&print=pretty'

Değere göre filtreleme

orderBy="$value" parametresini kullanarak düğümleri alt anahtarlarının değerine göre filtreleyebiliriz. Dinozorların bir dino spor yarışması yaptığını ve puanlarını aşağıdaki biçimde takip ettiğimizi varsayalım:

{
  "scores": {
    "bruhathkayosaurus": 55,
    "lambeosaurus": 21,
    "linhenykus": 80,
    "pterodactyl": 93,
    "stegosaurus": 5,
    "triceratops": 22
  }
}

Puanı 50'den yüksek olan tüm dinozorları almak için aşağıdaki isteği gönderebiliriz:

curl 'https://dinosaur-facts.firebaseio.com/scores.json?orderBy="$value"&startAt=50&print=pretty'

orderBy="$value" kullanılırken null, boole, dize ve nesne değerlerinin nasıl sıralandığıyla ilgili açıklama için Verilerin Sıralama Şekli başlıklı makaleyi inceleyin.

Karmaşık Filtreleme

Daha karmaşık sorgular oluşturmak için birden fazla parametreyi birleştirebiliriz.

Sınır Sorguları

limitToFirst ve limitToLast parametreleri, veri alınacak maksimum alt öğe sayısını belirlemek için kullanılır. 100 sınırı belirlersek yalnızca 100'e kadar eşleşen çocuk alırız. Veritabanında 100'den az mesaj varsa her çocuğu alırız. Ancak 100'den fazla mesajımız varsa bu mesajların yalnızca 100'ü için veri alırız. limitToFirst kullanıyorsak sıralanmış ilk 100 mesaj, limitToLast kullanıyorsak sıralanmış son 100 mesaj olacaktır.

Dinozorlarla ilgili bilgiler veritabanımızı ve orderBy'ü kullanarak en ağır iki dinozoru bulabiliriz:

curl 'https://dinosaur-facts.firebaseio.com/dinosaurs.json?orderBy="weight"&limitToLast=2&print=pretty'

Benzer şekilde, limitToFirst kullanarak en kısa iki dinozoru da bulabiliyoruz:

curl 'https://dinosaur-facts.firebaseio.com/dinosaurs.json?orderBy="height"&limitToFirst=2&print=pretty'

orderBy="$value" ile sınır sorguları da yapabiliriz. En yüksek puana sahip ilk üç dino spor yarışmacısını içeren bir skor tablosu oluşturmak istersek aşağıdakileri yapabiliriz:

curl 'https://dinosaur-facts.firebaseio.com/scores.json?orderBy="$value"&limitToLast=3&print=pretty'

Aralık Sorguları

startAt, endAt ve equalTo özelliğini kullanmak, sorgularımız için keyfi başlangıç ve bitiş noktaları seçmemize olanak tanır. Örneğin, en az üç metre boyunda olan tüm dinozorları bulmak isteseydik orderBy ve startAt özelliklerini birleştirebiliriz:

curl 'https://dinosaur-facts.firebaseio.com/dinosaurs.json?orderBy="height"&startAt=3&print=pretty'

Adları alfabetik olarak Pterodactyl'ten önce gelen tüm dinozorları bulmak için endAt kullanabiliriz:

curl 'https://dinosaur-facts.firebaseio.com/dinosaurs.json?orderBy="$key"&endAt="pterodactyl"&print=pretty'

Sorgumuzun her iki ucunu da sınırlamak için startAt ve endAt'ü birleştirebiliriz. Aşağıdaki örnekte, adı "b" harfi ile başlayan tüm dinozorlar bulunur:

curl 'https://dinosaur-facts.firebaseio.com/dinosaurs.json?orderBy="$key"&startAt="b"&endAt="b\uf8ff"&print=pretty'

Aralık sorgular, verilerinizi sayfalara ayırmanız gerektiğinde de yararlıdır.

Tüm unsurların birleşimi

Karmaşık sorgular oluşturmak için bu tekniklerin tümünü birleştirebiliriz. Örneğin, en sevdiğimiz tür olan Stegosaurus'tan daha kısa veya bu türe eşit boyda olan tüm dinozorların adını bulmak isteyebilirsiniz:

MY_FAV_DINO_HEIGHT=`curl "https://dinosaur-facts.firebaseio.com/dinosaurs/stegosaurus/height.json"`
curl "https://dinosaur-facts.firebaseio.com/dinosaurs.json?orderBy=\"height\"&endAt=${MY_FAV_DINO_HEIGHT}&print=pretty"

Verilerin Sıralama Şekli

Bu bölümde, üç filtreleme parametresinin her biri kullanıldığında verilerinizin nasıl sıralandığı açıklanmaktadır.

orderBy

orderBy, bir alt anahtar adıyla kullanıldığında, belirtilen alt anahtarı içeren veriler aşağıdaki gibi sıralanır:

1. Belirtilen alt anahtar için null değerine sahip alt öğeler önce gelir.
2. Ardından, belirtilen alt anahtar için false değerine sahip alt öğeler gelir. Birden fazla çocuğun değeri false ise anahtara göre alfabetik olarak sıralanır.
3. Ardından, belirtilen alt anahtar için true değerine sahip alt öğeler gelir. Birden fazla alt öğenin değeri true ise bu öğeler anahtara göre alfabetik olarak sıralanır.
4. Ardından, sayısal değere sahip alt öğeler artan düzende sıralanır. Birden fazla alt öğe, belirtilen alt öğe düğümü için aynı sayısal değere sahipse anahtara göre sıralanır.
5. Dizelerin sırası, sayılardan sonra gelir ve alfabetik olarak artan düzendedir. Belirtilen alt düğüm için birden fazla alt öğenin değeri aynıysa bu öğeler anahtara göre alfabetik olarak sıralanır.
6. Nesneler en sona gelir ve anahtara göre artan düzende alfabetik olarak sıralanır.

orderBy="$key"

Verilerinizi sıralamak için orderBy="$key" parametresi kullanıldığında veriler, aşağıdaki gibi anahtara göre artan düzende döndürülür. Anahtarların yalnızca dize olabileceğini unutmayın.

1. 32 bitlik tam sayı olarak ayrıştırılabilen bir anahtara sahip alt öğeler önce gelir ve artan düzende sıralanır.
2. Ardından, anahtarı dize değeri olan alt öğeler gelir. Bunlar, artan sözlük sırasına göre dizilir.

orderBy="$value"

Verilerinizi sıralamak için orderBy="$value" parametresini kullandığınızda alt öğeler değerlerine göre sıralanır. Sıralama ölçütleri, belirtilen alt anahtarın değeri yerine düğümün değeri kullanıldığı dışında bir alt anahtara göre sıralanan verilerle aynıdır.

orderBy="$priority"

Verilerinizi sıralamak için orderBy="$priority" parametresini kullandığınızda alt öğelerin sıralaması, önceliklerine ve anahtarlarına göre aşağıdaki gibi belirlenir. Öncelik değerlerinin yalnızca sayı veya dize olabileceğini unutmayın.

1. Önceliği olmayan çocuklar (varsayılan) önce gelir.
2. Önceliği numara olan çocuklar sonraki sıradadır. Öncelik sırasına göre küçükten büyüğe doğru sayısal olarak sıralanır.
3. Önceliği dize olan çocuklar en son gelir. Öncelik sırasına göre alfabetik olarak sıralanır.
4. İki alt öğe aynı önceliğe sahip olduğunda (öncelik yok dahil) anahtara göre sıralanır. Önce sayısal anahtarlar (sayısal olarak sıralanır), ardından kalan anahtarlar (alfabetik olarak sıralanır) gelir.

Öncelikler hakkında daha fazla bilgi için API referansı bölümüne bakın.

REST API'den aktarma

Firebase REST uç noktaları, EventSource/Sunucu Tarafından Gönderilen Etkinlikler protokolünü destekler. Bu sayede, değişiklikleri Firebase veritabanımızdaki tek bir konuma aktarmak kolaylaşır.

Akış yapmaya başlamak için aşağıdakileri yapmamız gerekir:

1. İstemcinin Kabul üstbilgisini text/event-stream olarak ayarlayın
2. HTTP yönlendirmelerine (özellikle HTTP durum kodu 307) uyma
3. Firebase veritabanı konumu için okuma izni gerekiyorsa auth sorgu parametresini ekleyin

Sunucu, istenen URL'deki verilerin durumu değiştikçe adlandırılmış etkinlikler gönderir. Bu mesajların yapısı EventSource protokolüne uygundur:

event: event name
data: JSON encoded data payload

Sunucu aşağıdaki etkinlikleri gönderebilir:

Aşağıda, sunucunun gönderebileceği bir etkinlik grubu örneği verilmiştir:

// Set your entire cache to {"a": 1, "b": 2}
event: put
data: {"path": "/", "data": {"a": 1, "b": 2}}


// Put the new data in your cache under the key 'c', so that the complete cache now looks like:
// {"a": 1, "b": 2, "c": {"foo": true, "bar": false}}
event: put
data: {"path": "/c", "data": {"foo": true, "bar": false}}


// For each key in the data, update (or add) the corresponding key in your cache at path /c,
// for a final cache of: {"a": 1, "b": 2, "c": {"foo": 3, "bar": false, "baz": 4}}
event: patch
data: {"path": "/c", "data": {"foo": 3, "baz": 4}}

Go kullanıyorsanız Firebase REST ve Streaming API'lerini kapsayan üçüncü taraf bir sarmalayıcı olan Firego'ya göz atın.