Condividi tramite


Guida introduttiva: Libreria client di Azure Cosmos DB for Apache Cassandra per Python

Introduzione alla libreria client di Azure Cosmos DB per Apache Cassandra per Python per archiviare, gestire ed eseguire query sui dati non strutturati. Seguire la procedura descritta in questa guida per creare un nuovo account, installare una libreria client Python, connettersi all'account, eseguire operazioni comuni ed eseguire query sui dati di esempio finali.

Documentazione | Codice sorgente | della libreriaPacchetto (PyPI)

Prerequisiti

  • Una sottoscrizione di Azure

    • Se non si ha una sottoscrizione di Azure, creare un account gratuito prima di iniziare.
  • Python 3.12 o versione successiva

Configurazione

Prima di tutto, configurare l'account e l'ambiente di sviluppo per questa guida. Questa sezione illustra il processo di creazione di un account, il recupero delle credenziali e la preparazione dell'ambiente di sviluppo.

Crea un account

Per iniziare, creare un'API per l'account Apache Cassandra. Dopo aver creato l'account, creare il keyspace e le risorse della tabella.

  1. Se non si ha già un gruppo di risorse di destinazione, usare il az group create comando per creare un nuovo gruppo di risorse nella sottoscrizione.

    az group create \
        --name "<resource-group-name>" \
        --location "<location>"
    
  2. Usare il az cosmosdb create comando per creare un nuovo account Azure Cosmos DB per Apache Cassandra con le impostazioni predefinite.

    az cosmosdb create \
        --resource-group "<resource-group-name>" \
        --name "<account-name>" \
        --locations "regionName=<location>" \
        --capabilities "EnableCassandra"
    
  3. Creare un nuovo keyspace utilizzando az cosmosdb cassandra keyspace create denominato cosmicworks.

    az cosmosdb cassandra keyspace create \
        --resource-group "<resource-group-name>" \
        --account-name "<account-name>" \
        --name "cosmicworks"
    
  4. Creare un nuovo oggetto JSON per rappresentare lo schema usando un comando Bash a più righe. Usare quindi il az cosmosdb cassandra table create comando per creare una nuova tabella denominata products.

    schemaJson=$(cat <<EOF
    {
      "columns": [
        {
          "name": "id",
          "type": "text"
        },
        {
          "name": "name",
          "type": "text"
        },
        {
          "name": "category",
          "type": "text"
        },
        {
          "name": "quantity",
          "type": "int"
        },
        {
          "name": "price",
          "type": "decimal"
        },
        {
          "name": "clearance",
          "type": "boolean"
        }
      ],
      "partitionKeys": [
        {
          "name": "id"
        }
      ]
    }
    EOF
    )
    
    az cosmosdb cassandra table create \
        --resource-group "<resource-group-name>" \
        --account-name "<account-name>" \
        --keyspace-name "cosmicworks" \
        --name "product" \
        --schema "$schemaJson"
    

Ottenere le credenziali

Ottenere ora la password per la libreria client da usare per creare una connessione all'account creato di recente.

  1. Usare az cosmosdb show per ottenere il punto di contatto e il nome utente per l'account.

    az cosmosdb show \
        --resource-group "<resource-group-name>" \
        --name "<account-name>" \
        --query "{username:name,contactPoint:documentEndpoint}"
    
  2. Registrare il valore delle proprietà contactPoint e username dall'output dei comandi precedenti. Questi valori delle proprietà sono il punto di contatto e il nome utente usati più avanti in questa guida per connettersi all'account con la libreria.

  3. Usare az cosmosdb keys list per ottenere le chiavi per l'account.

    az cosmosdb keys list \
        --resource-group "<resource-group-name>" \
        --name "<account-name>" \
        --type "keys"
    
  4. Registrare il valore della primaryMasterKey proprietà dall'output dei comandi precedenti. Il valore di questa proprietà è la password usata più avanti in questa guida per connettersi all'account con la libreria.

Preparare l'ambiente di sviluppo

Configurare quindi l'ambiente di sviluppo con un nuovo progetto e la libreria client. Questo passaggio è l'ultimo prerequisito necessario prima di passare al resto di questa guida.

  1. Iniziare in una directory vuota.

  2. Importare il cassandra-driver pacchetto dall'indice del pacchetto Python (PyPI).

    pip install cassandra-driver
    
  3. Creare il file app.py.

Modello a oggetti

Descrizione
Cluster Rappresenta una connessione specifica a un cluster

Esempi di codice

Autenticare il client

Per iniziare, autenticare il client usando le credenziali raccolte in precedenza in questa guida.

  1. Aprire il file app.py nell'ambiente di sviluppo integrato (IDE).

  2. Importare i tipi seguenti dal cassandra-driver modulo:

    • cassandra.cluster.Cluster
    • cassandra.auth.PlainTextAuthProvider
    from cassandra.cluster import Cluster
    from cassandra.auth import PlainTextAuthProvider
    
  3. Importare i tipi seguenti dal ssl modulo:

    • ssl.PROTOCOL_TLS_CLIENT
    • ssl.SSLContext
    • ssl.CERT_NONE
    from ssl import PROTOCOL_TLS_CLIENT, SSLContext, CERT_NONE
    
  4. Creare variabili stringa per le credenziali raccolte in precedenza in questa guida. Nomina le variabili username, password e contactPoint.

    username = "<username>"
    password = "<password>"
    contactPoint = "<contact-point>"
    
  5. SSLContext Configurare creando una nuova variabile denominata ssl_context, impostando il protocollo su PROTOCOL_TLS_CLIENT, disabilitando il controllo del nome host e impostando la modalità di verifica su CERT_NONE.

    ssl_context = SSLContext(PROTOCOL_TLS_CLIENT)
    ssl_context.check_hostname = False
    ssl_context.verify_mode = CERT_NONE
    
  6. Creare un nuovo PlainTextAuthProvider oggetto con le credenziali specificate nei passaggi precedenti. Archiviare il risultato in una variabile denominata auth_provider.

    auth_provider = PlainTextAuthProvider(username=username, password=password)
    
  7. Creare un Cluster oggetto usando le credenziali e le variabili di configurazione create nei passaggi precedenti. Archiviare il risultato in una variabile denominata cluster.

    cluster = Cluster([contactPoint], port=10350, auth_provider=auth_provider, ssl_context=ssl_context)
    
  8. Connettersi al cluster.

    session = cluster.connect("cosmicworks")
    

Avvertimento

La convalida completa di TLS (Transport Layer Security) è disabilitata in questa guida per semplificare l'autenticazione. Per le distribuzioni di produzione, abilitare completamente la convalida.

Aggiornare o inserire i dati

Eseguire quindi l'operazione di upsert dei nuovi dati in una tabella. L'upserting garantisce che i dati vengano creati o sostituiti in modo appropriato a seconda che nella tabella esistano già gli stessi dati.

  1. Creare una nuova variabile stringa denominata insertQuery con la query CQL (Cassandra Query Language) per inserire una nuova riga.

    insertQuery = """
    INSERT INTO
        product (id, name, category, quantity, price, clearance)
    VALUES
        (%(id)s, %(name)s, %(category)s, %(quantity)s, %(price)s, %(clearance)s)
    """
    
  2. Creare un nuovo oggetto con varie proprietà di un nuovo prodotto e archiviarlo in una variabile denominata params.

    params = {
        "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
        "name": "Yamba Surfboard",
        "category": "gear-surf-surfboards",
        "quantity": 12,
        "price": 850.00,
        "clearance": False
    }
    
  3. Usare la execute funzione per eseguire la query con i parametri specificati.

    session.execute(insertQuery, params)
    

Leggere dati

Leggere quindi i dati precedentemente inseriti nella tabella.

  1. Creare una nuova variabile stringa denominata readQuery con una query CQL che corrisponde agli elementi con lo stesso id campo.

    readQuery = "SELECT * FROM product WHERE id = %s LIMIT 1"
    
  2. Creare una variabile stringa denominata id con lo stesso valore del prodotto creato in precedenza in questa guida.

    id = "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
    
  3. Usa la funzione execute per eseguire la query archiviata in readQuery, passando la variabile id come argomento. Archiviare il risultato in una variabile denominata readResults.

    readResults = session.execute(readQuery, (id,))
    
  4. Usare la one funzione per ottenere il risultato singolo previsto. Archiviare questo singolo risultato in una variabile denominata matchedProduct.

    matchedProduct = readResults.one()
    

Dati di query

Usare infine una query per trovare tutti i dati corrispondenti a un filtro specifico nella tabella.

  1. Creare variabili stringa denominate findQuery e category con la query CQL e il parametro obbligatorio.

    findQuery = "SELECT * FROM product WHERE category = %s ALLOW FILTERING"
    category = "gear-surf-surfboards"
    
  2. Usare le due variabili stringa e la funzione execute per eseguire query su più risultati. Archiviare il risultato di questa query in una variabile denominata findResults.

    findResults = session.execute(findQuery, (category,))
    
  3. Usare un ciclo for per scorrere i risultati della query.

    for row in findResults:
        # Do something here with each result
    

Eseguire il codice

Eseguire l'applicazione appena creata usando un terminale nella directory dell'applicazione.

python app.py

Pulire le risorse

Quando l'account non è più necessario, rimuovere l'account dalla sottoscrizione di Azure eliminando la risorsa.

az cosmosdb delete \
    --resource-group "<resource-group-name>" \
    --name "<account-name>"

Passo successivo