Öğretici: Azure Static Web Apps'te PostgreSQL veritabanı bağlantısı ekleme (önizleme)

Bu öğreticide, PostgreSQL için Azure Veritabanı Tek Sunucu veya Esnek Sunucu veritabanını statik web uygulamanıza bağlamayı öğreneceksiniz. Yapılandırıldıktan sonra, arka uç kodu yazmak zorunda kalmadan verileri işlemek için yerleşik /data-api uç noktaya REST veya GraphQL istekleri yapabilirsiniz.

Kolaylık olması açısından bu öğreticide yerel geliştirme amacıyla Azure veritabanının nasıl kullanılacağı gösterilmektedir, ancak yerel geliştirme gereksinimleriniz için yerel bir veritabanı sunucusu da kullanabilirsiniz.

Bu öğreticide aşağıdakilerin nasıl yapılacağını öğreneceksiniz:

Önkoşullar

Bu öğreticiyi tamamlamak için mevcut bir PostgreSQL için Azure Veritabanı Esnek Sunucu veya Tek Sunucu ve statik web uygulamasına sahip olmanız gerekir. Ayrıca, Azure Data Studio'yu yüklemeniz gerekir.

Veritabanınızı Azure Static Web Apps veritabanı bağlantı özelliğiyle çalışacak şekilde yapılandırarak başlayın.

Veritabanı bağlantısını yapılandırma

Veritabanı bağlantılarının çalışması için Azure Static Web Apps'in veritabanınıza ağ erişimi olmalıdır. Ayrıca, yerel geliştirme için bir Azure veritabanı kullanmak için veritabanınızı kendi IP adresinizden gelen isteklere izin verecek şekilde yapılandırmanız gerekir.

1. Azure portalında PostgreSQL için Azure Veritabanı Sunucunuza gidin.

2. Esnek Sunucu PostgreSQL için Azure Veritabanı kullanıyorsanız Ayarlar bölümünün altında Ağ'ı seçin. PostgreSQL için Azure Veritabanı Tek Sunucu kullanıyorsanız Ayarlar bölümünün altında Bağlantı güvenliği'ni seçin.

3. Güvenlik duvarı kuralları bölümünde Geçerli istemci IP adresinizi ekleyin düğmesini seçin. Bu adım, yerel geliştirmeniz için bu veritabanını kullanabilmenizi sağlar.

4. Güvenlik duvarı kuralları bölümünde Azure'ın içindeki herhangi bir Azure hizmetinden bu sunucuya genel erişime izin ver onay kutusunu seçin. PostgreSQL için Azure Veritabanı Tek Sunucu kullanıyorsanız, bu iki durumlu düğme Azure hizmetlerine erişime izin ver olarak etiketlenmiştir. Bu adım, dağıtılan Statik Web Uygulamaları kaynağınızın veritabanınıza erişmesini sağlar.

5. Kaydet'i seçin.

Yerel geliştirme için veritabanı bağlantı dizesi alma

Yerel geliştirme için Azure veritabanınızı kullanmak için veritabanınızın bağlantı dizesi almanız gerekir. Geliştirme amacıyla yerel veritabanı kullanmayı planlıyorsanız bu adımı atlayabilirsiniz.

1. Azure portalında PostgreSQL için Azure Veritabanı Sunucunuza gidin.

2. Ayarlar bölümünde Bağlantı dizeleri'ni seçin.

3. ADO.NET kutusundan bağlantı dizesi kopyalayın ve bir metin düzenleyicisinde bir kenara bırakın.

4. {your_password} bağlantı dizesi yer tutucuyu parolanızla değiştirin.

5. Yer tutucuyu {your_database} veritabanı adıyla MyTestPersonDatabasedeğiştirin. öğesini önümüzdeki adımlarda oluşturacaksınız MyTestPersonDatabase .

6. Yerel geliştirme için bu bağlantı dizesi kullanmak için bağlantı dizesi sonuna eklemeTrust Server Certificate=True;.

Örnek veri oluşturma

Örnek bir tablo oluşturun ve öğreticiyle eşleşecek örnek verilerle bu tabloyu dağıtın. Bu öğreticide Azure Data Studio kullanılır, ancak PgAdmin veya başka bir araç kullanabilirsiniz.

1. Azure Data Studio'da PostgreSQL için Azure Veritabanı Sunucunuza bağlantı oluşturun

2. Sunucunuza sağ tıklayın ve Yeni Sorgu'yu seçin. adlı MyTestPersonDatabasebir veritabanı oluşturmak için aşağıdaki sorguyu çalıştırın.

   CREATE DATABASE "MyTestPersonDatabase";
   

3. Sunucunuza sağ tıklayın ve Yenile'yi seçin.

4. Öğesine MyTestPersonDatabase sağ tıklayın ve Yeni Sorgu'yu seçin. adlı MyTestPersonTableyeni bir tablo oluşturmak için aşağıdaki sorguyu çalıştırın.

   CREATE TABLE "MyTestPersonTable" (
       "Id" SERIAL PRIMARY KEY,
       "Name" VARCHAR(25) NULL
   );
   

5. MyTestPersonTable tablosuna veri eklemek için aşağıdaki sorguları çalıştırın.

   INSERT INTO "MyTestPersonTable" ("Name")
   VALUES ('Sunny');
   
   INSERT INTO "MyTestPersonTable" ("Name")
   VALUES ('Dheeraj');
   

Statik web uygulamasını yapılandırma

Bu öğreticinin geri kalanı, veritabanı bağlantılarını yerel olarak kullanmak için statik web uygulamanızın kaynak kodunu düzenlemeye odaklanır.

1. Dala main geçin.

   • Bash
   • PowerShell

   git checkout main
   

2. kullanarak git pullyerel sürümünüzü GitHub'da bulunanlarla eşitleyin.

   • Bash
   • PowerShell

   git pull origin main
   

Veritabanı yapılandırma dosyasını oluşturma

Ardından, statik web uygulamanızın veritabanıyla arabirim oluşturmak için kullandığı yapılandırma dosyasını oluşturun.

1. Terminalinizi açın ve bağlantı dizesi tutmak için yeni bir değişken oluşturun. Söz dizimi, kullandığınız kabuk türüne bağlı olarak değişebilir.

   • Bash
   • PowerShell

   export DATABASE_CONNECTION_STRING='<YOUR_CONNECTION_STRING>'
   

   değerini bir metin düzenleyicisinde ayırdığınız bağlantı dizesi değeriyle değiştirdiğinizden <YOUR_CONNECTION_STRING> emin olun.

2. Statik Web Uygulamaları CLI'sını yüklemek veya güncelleştirmek için npm kullanın. Durumunuz için en uygun komutu seçin.

   Yüklemek için kullanın npm install.

   npm install -g @azure/static-web-apps-cli
   

   npm install -g @azure/static-web-apps-cli
   

   Güncelleştirmek için kullanın npm update.

   npm update
   

   npm update
   

3. swa db init Veritabanı yapılandırma dosyası oluşturmak için komutunu kullanın.

   • Bash
   • PowerShell

   swa db init --database-type postgresql
   

   init komutu swa-db-connections klasöründe staticwebapp.database.config.json dosyasını oluşturur.

4. Bu örneği, oluşturduğunuz staticwebapp.database.config.json dosyaya yapıştırın.

{
  "$schema": "https://github.com/Azure/data-api-builder/releases/latest/download/dab.draft.schema.json",
  "data-source": {
    "database-type": "postgresql",
    "options": {
      "set-session-context": false 
    },
    "connection-string": "@env('DATABASE_CONNECTION_STRING')"
  },
  "runtime": {
    "rest": {
      "enabled": true,
      "path": "/rest"
    },
    "graphql": {
      "allow-introspection": true,
      "enabled": true,
      "path": "/graphql"
    },
    "host": {
      "mode": "production",
      "cors": {
        "origins": ["http://localhost:4280"],
        "allow-credentials": false
      },
      "authentication": {
        "provider": "StaticWebApps"
      }
    }
  },
  "entities": {
    "Person": {
      "source": "MyTestPersonTable",
      "permissions": [
        {
          "actions": ["*"],
          "role": "anonymous"
        }
      ]
    }
  }
}

Sonraki adıma geçmeden önce, yapılandırma dosyasının farklı yönlerini açıklayan aşağıdaki tabloyu gözden geçirin. Yapılandırma dosyası ve öğe düzeyinde güvenlik için ilişkiler ve ilkeler gibi işlevlerle ilgili tam belgeler için Data API Builder belgelerine bakın.

Statik web uygulaması veritabanına bağlanacak şekilde yapılandırıldığında bağlantıyı doğrulayabilirsiniz.

Giriş sayfasını güncelleştirme

index.html dosyasındaki body etiketler arasındaki işaretlemeyi aşağıdaki HTML ile değiştirin.

<h1>Static Web Apps Database Connections</h1>
<blockquote>
    Open the console in the browser developer tools to see the API responses.
</blockquote>
<div>
    <button id="list" onclick="list()">List</button>
    <button id="get" onclick="get()">Get</button>
    <button id="update" onclick="update()">Update</button>
    <button id="create" onclick="create()">Create</button>
    <button id="delete" onclick="del()">Delete</button>
</div>
<script>
    // add JavaScript here
</script>

Uygulamayı yerel olarak başlatma

Artık web sitenizi çalıştırabilir ve veritabanındaki verileri doğrudan işleyebilirsiniz.

1. Veritabanı yapılandırmasıyla statik web uygulamasını başlatın.

   swa start --data-api-location swa-db-connections
   

CLI başlatıldığından, staticwebapp.database.config.json dosyasında tanımlandığı gibi uç noktalar aracılığıyla veritabanınıza erişebilirsiniz.

Verileri işleme

Aşağıdaki framework-agnostic komutları veritabanınızda tam CRUD işlemlerinin nasıl yapılacağını gösterir.

Her işlevin çıkışı tarayıcının konsol penceresinde görüntülenir.

CMD/CTRL + SHIFT + I tuşlarına basarak geliştirici araçlarını açın ve Konsol sekmesini seçin.

Tüm öğeleri listeleme

index.html etiketleri arasına script aşağıdaki kodu ekleyin.

async function list() {
  const endpoint = '/data-api/rest/Person';
  const response = await fetch(endpoint);
  const data = await response.json();
  console.table(data.value);
}

async function list() {

  const query = `
      {
        people {
          items {
            Id
            Name
          }
        }
      }`;

  const endpoint = "/data-api/graphql";
  const response = await fetch(endpoint, {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: JSON.stringify({ query: query })
  });
  const result = await response.json();
  console.table(result.data.people.items);
}

Sayfayı yenileyin ve Liste düğmesini seçin.

Tarayıcının konsol penceresinde artık veritabanındaki tüm kayıtları listeleyen bir tablo görüntülenir.

İşte tarayıcınızda nasıl görünmesi gerektiğinin ekran görüntüsü.

Kimliğe göre alma

index.html etiketleri arasına script aşağıdaki kodu ekleyin.

async function get() {
  const id = 1;
  const endpoint = `/data-api/rest/Person/Id`;
  const response = await fetch(`${endpoint}/${id}`);
  const result = await response.json();
  console.table(result.value);
}

async function get() {

  const id = 1;

  const gql = `
    query getById($id: Int!) {
      person_by_pk(Id: $id) {
        Id
        Name
      }
    }`;

  const query = {
    query: gql,
    variables: {
      id: id,
    },
  };

  const endpoint = "/data-api/graphql";
  const response = await fetch(endpoint, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(query),
  });
  const result = await response.json();
  console.table(result.data.person_by_pk);
}

Sayfayı yenileyin ve Al düğmesini seçin.

Tarayıcının konsol penceresinde artık veritabanından istenen tek kaydın listelendiği bir tablo görüntülenir.

Güncelleştir

index.html etiketleri arasına script aşağıdaki kodu ekleyin.

async function update() {

  const id = 1;
  const data = {
    Name: "Molly"
  };

  const endpoint = '/data-api/rest/Person/Id';
  const response = await fetch(`${endpoint}/${id}`, {
    method: "PUT",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
  });
  const result = await response.json();
  console.table(result.value);
}

async function update() {

  const id = 1;
  const data = {
    Name: "Molly"
  };

  const gql = `
    mutation update($id: Int!, $item: UpdatePersonInput!) {
      updatePerson(Id: $id, item: $item) {
        Id
        Name
      }
    }`;

  const query = {
    query: gql,
    variables: {
      id: id,
      item: data
    } 
  };

  const endpoint = "/data-api/graphql";
  const res = await fetch(endpoint, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(query)
  });

  const result = await res.json();
  console.table(result.data.updatePerson);
}

Sayfayı yenileyin ve Güncelleştir düğmesini seçin.

Tarayıcının konsol penceresinde artık güncelleştirilmiş verileri gösteren bir tablo görüntülenir.

Oluşturma

index.html etiketleri arasına script aşağıdaki kodu ekleyin.

async function create() {

  const data = {
    Name: "Pedro"
  };

  const endpoint = `/data-api/rest/Person/`;
  const response = await fetch(endpoint, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(data)
  });
  const result = await response.json();
  console.table(result.value);
}

async function create() {

  const data = {
    Name: "Pedro"
  };

  const gql = `
    mutation create($item: CreatePersonInput!) {
      createPerson(item: $item) {
        Id
        Name
      }
    }`;

  const query = {
    query: gql,
    variables: {
      item: data
    } 
  };

  const endpoint = "/data-api/graphql";
  const result = await fetch(endpoint, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(query)
  });

  const response = await result.json();
  console.table(response.data.createPerson);
}

Sayfayı yenileyin ve Oluştur düğmesini seçin.

Tarayıcının konsol penceresinde artık veritabanındaki yeni kaydı gösteren bir tablo görüntülenir.

Sil

index.html etiketleri arasına script aşağıdaki kodu ekleyin.

async function del() {
  const id = 3;
  const endpoint = '/data-api/rest/Person/Id';
  const response = await fetch(`${endpoint}/${id}`, {
    method: "DELETE"
  });
  if(response.ok) {
    console.log(`Record deleted: ${ id }`)
  } else {
    console.log(response);
  }
}

async function del() {

  const id = 3;

  const gql = `
    mutation del($id: Int!) {
      deletePerson(Id: $id) {
        Id
      }
    }`;

  const query = {
    query: gql,
    variables: {
      id: id
    }
  };

  const endpoint = "/data-api/graphql";
  const response = await fetch(endpoint, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify(query)
  });

  const result = await response.json();
  console.log(`Record deleted: ${ result.data.deletePerson.Id }`);
}

Sayfayı yenileyin ve Sil düğmesini seçin.

Tarayıcının konsol penceresinde artık silme isteğinden gelen yanıtı gösteren bir tablo görüntülenir.

Kayıt silindi: 3

Artık sitenizle yerel olarak çalıştığınıza göre, artık bunu Azure'a dağıtabilirsiniz.

Sitenizi dağıtma

Bu siteyi üretim ortamına dağıtmak için yapılandırma dosyasını işlemeniz ve değişikliklerinizi sunucuya göndermeniz yeterlidir.

1. İzlemek için dosya değişikliklerini ekleyin.

   git add .
   

2. Yapılandırma değişikliklerini işleme.

   git commit -am "Add database configuration"
   

3. Değişikliklerinizi sunucuya gönderme.

   git push origin main
   

Veritabanını statik web uygulamanıza bağlama

Sitenizin Statik Web Apps örneği ile veritabanınız arasında bağlantı oluşturmak için aşağıdaki adımları kullanın.

1. Statik web uygulamanızı Azure portalında açın.

2. Ayarlar bölümünde Veritabanı bağlantısı'nı seçin.

3. Üretim bölümünün altında Var olan veritabanını bağla bağlantısını seçin.

4. Var olan veritabanını bağla penceresinde aşağıdaki değerleri girin:

   Özellik	Değer
   Veritabanı Türü	Açılan listeden veritabanı türünüzü seçin.
   Abonelik	Açılan listeden Azure aboneliğinizi seçin.
   Kaynak Adı	İstediğiniz veritabanını içeren veritabanı sunucusu adını seçin.
   Veritabanı Adı	Statik web uygulamanıza bağlamak istediğiniz veritabanının adını seçin.
   Kimlik Doğrulaması Türü	Bağlantı dizesi'ni seçin ve PostgreSQL kullanıcı adını ve parolasını girin. PostgreSQL Tek Sunucu için son eki eklemeyin @servername .

5. Tamam'ı seçin.

Veritabanınızın Statik Web Apps kaynağınıza bağlı olduğunu doğrulayın

Veritabanınızı statik web uygulamanıza bağladıktan ve sitenin oluşturulması tamamlandıktan sonra, veritabanı bağlantısını doğrulamak için aşağıdaki adımları kullanın.

1. Statik web uygulamanızı Azure portalında açın.

2. Temel Bileşenler bölümünde Statik Web Apps kaynağınızın URL'sini seçerek statik web uygulamanıza gidin.

3. Tüm öğeleri listelemek için Listele düğmesini seçin.

   Çıktı, bu ekran görüntüsünde gösterilene benzemelidir.

   

Kaynakları temizleme

Bu öğretici sırasında oluşturulan kaynakları kaldırmak istiyorsanız veritabanının bağlantısını kaldırmanız ve örnek verileri kaldırmanız gerekir.

1. Veritabanının bağlantısını kaldırma: Statik web uygulamanızı Azure portalında açın. Ayarlar bölümünde Veritabanı bağlantısı'nı seçin. Bağlı veritabanının yanında Ayrıntıları görüntüle'yi seçin. Veritabanı bağlantısı ayrıntıları penceresinde Bağlantıyı Kaldır düğmesini seçin.

2. Örnek verileri kaldırma: Veritabanınızda adlı MyTestPersonTabletabloyu silin.

Sonraki adımlar