Getting started

---

1. Install cqlc

2. Set up your cassandra schema:

   Ensure that your Cassandra keyspace and tables are properly defined. For example, you might have a schema.cql file with the following content:

   schema.cql

    CREATE KEYSPACE IF NOT EXISTS your_keyspace WITH replication = {'class': 'SimpleStrategy', 'replication_factor': 1};
   
    USE your_keyspace;
   
    CREATE TABLE IF NOT EXISTS users (
        user_id    UUID PRIMARY KEY,
        username   TEXT,
        email      TEXT,
        created_at TIMESTAMP
    );
   

3. Define your cql queries:

   Create a queries.cql file containing your CQL queries. For example:

   queries.cql

    -- name: CreateUser :exec
    INSERT INTO users (user_id, username, email, created_at) VALUES (?, ?, ?, ?);
   
    -- name: FindUser :one
    SELECT * FROM users WHERE user_id = ? LIMIT 1;
   

4. Create a configuration file:

   In your project directory, create a cqlc.yaml configuration file with the following content:

   cqlc.yaml

    cql:
    - queries: "queries.cql"
      schema: "schema.cql"
      gen:
        go:
          package: "gencql"
          out: "gencql"
   

   This configuration specifies that the generated code will be placed in the gencql directory under the gencql package, using queries.cql for the CQL queries and schema.cql for the database schema.

5. Generate go code:

   Run the cqlc tool to generate Go code from your CQL queries:

   cqlc generate
   

   This command will generate Go files in the gencql directory as specified in your configuration.

6. Integrate into your go application:

   Use the generated code in your Go application:

   main.go

    package main
   
    import (
      "context"
      "log"
      "time"
   
      "your.project/gencql"
      "github.com/gocql/gocql"
    )
   
    //go:generate cqlc generate
   
    func main() {
      cluster := gocql.NewCluster("127.0.0.1")
      cluster.Keyspace = "your_keyspace"
      session, err := cluster.CreateSession()
      if err != nil {
        log.Fatal(err)
      }
      defer session.Close()
   
      client, err := gencql.NewClient(session, nil)
      if err != nil {
        log.Fatal(err)
      }
      userID := gocql.TimeUUID()
      err = client.CreateUser(context.Background(), &gencql.CreateUserParams{
        UserID:    userID,
        Username:  "John Doe",
        Email:     "john.doe@example.com",
        CreatedAt: time.Now(),
      })
      if err != nil {
        log.Fatal(err)
      }
   
      user, err := client.FindUser(context.Background(), &gencql.FindUserParams{UserID: userID})
      if err != nil {
        log.Fatal(err)
      }
   
      log.Printf("User: %+v\n", user)
    }