Work with . and & in field names (Go)
You must use & to escape any . or & in field names when the field is used in a filter, sort, projection, update, or indexing clause.
Dot notation, which is used to reference nested fields, should not be escaped.
For example, in the following document, you would use escaping like this: areas.r&&d, costs.price&.usd, and costs.price&.cad.
{
"areas": {
"r&d": true,
"design": false
},
"costs": {
"price.usd": 100,
"price.cad": 90
}
}You should not escape . or & in field names when you insert or replace a document.
For example:
package main
import (
"context"
"fmt"
"log"
"github.com/datastax/astra-db-go/v2/astra"
"github.com/datastax/astra-db-go/v2/astra/filter"
"github.com/datastax/astra-db-go/v2/astra/options"
)
func main() {
ctx := context.Background()
// Get an existing collection
client := astra.NewClient(
options.API().SetEnvironment(options.EnvironmentHCD),
)
database := client.Database(
"API_ENDPOINT",
options.API().
SetUsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD",
).
SetKeyspace("KEYSPACE_NAME"),
)
collection := database.Collection("COLLECTION_NAME")
// Replace a document
var result astra.Document
err := collection.FindOneAndReplace(
ctx,
filter.And(
filter.Eq("areas.r&&d", false),
filter.Lt("costs.price&.usd", 300),
),
map[string]any{
"areas": map[string]any{
"r&d": false,
"design": true,
},
"costs": map[string]any{
"price.usd": 100,
"price.cad": 90,
},
},
).Decode(&result)
if err != nil {
log.Fatal(err)
}
fmt.Println(result.ToMap())
}You can also use the EscapeFieldNames function provided by the client:
package main
import (
"context"
"fmt"
"log"
"github.com/datastax/astra-db-go/v2/astra"
"github.com/datastax/astra-db-go/v2/astra/filter"
"github.com/datastax/astra-db-go/v2/astra/options"
)
func main() {
ctx := context.Background()
// Get an existing collection
client := astra.NewClient(
options.API().SetEnvironment(options.EnvironmentHCD),
)
database := client.Database(
"API_ENDPOINT",
options.API().
SetUsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD",
).
SetKeyspace("KEYSPACE_NAME"),
)
collection := database.Collection("COLLECTION_NAME")
// Replace a document
var result astra.Document
err := collection.FindOneAndReplace(
ctx,
filter.And(
filter.Eq(astra.EscapeFieldNames("areas", "r&d"), false),
filter.Lt(astra.EscapeFieldNames("costs", "price.usd"), 300),
),
map[string]any{
"areas": map[string]any{
"r&d": false,
"design": true,
},
"costs": map[string]any{
"price.usd": 100,
"price.cad": 90,
},
},
).Decode(&result)
if err != nil {
log.Fatal(err)
}
fmt.Println(result.ToMap())
}