commentary for index

Author: Shubham8287

Cargo.lock

@@ -344,6 +344,8 @@ impl IndexArg {
 
         Ok(ValidatedIndex {
             is_unique: self.is_unique,
+            // This must be the canonical name (name used internally in database),
+            // as it is used in `index_id_from_name` abi.
             index_name: self.name.as_ref().map(|s| s.value()).unwrap_or_else(gen_index_name),
             accessor_name: &self.accessor,
             kind,

crates/bindings-macro/src/table.rs

@@ -595,7 +595,7 @@ impl Lang for Csharp<'_> {
                 let mut index_names = Vec::new();
 
                 for idx in iter_indexes(table) {
-                    let Some(accessor_name) = idx.accessor_name.as_ref() else {
+                    let Some(accessor_name) = idx.codegen_name.as_ref() else {
                         // If there is no accessor name, we shouldn't generate a client-side index accessor.
                         continue;
                     };

crates/codegen/src/csharp.rs

@@ -721,7 +721,7 @@ fn write_table_opts<'a>(
         // no actual way for the user to set the actual index name.
         // I think we should standardize: name and accessorName as the way to set
         // the name and accessor name of an index across all SDKs.
-        if let Some(accessor_name) = &index_def.accessor_name {
+        if let Some(accessor_name) = &index_def.codegen_name {
             writeln!(out, "{{ name: '{}', algorithm: 'btree', columns: [", accessor_name);
         } else {
             writeln!(out, "{{ name: '{}', algorithm: 'btree', columns: [", index_def.name);

crates/codegen/src/typescript.rs

@@ -65,7 +65,7 @@ impl Lang for UnrealCpp<'_> {
         let mut multi_key_indexes = Vec::new();
 
         for idx in iter_indexes(table) {
-            let Some(accessor_name) = idx.accessor_name.as_ref() else {
+            let Some(accessor_name) = idx.codegen_name.as_ref() else {
                 continue;
             };
 
@@ -1061,7 +1061,7 @@ fn generate_table_cpp(module: &ModuleDef, table: &TableDef, module_name: &str, s
     let mut multi_key_indexes = Vec::new();
 
     for idx in iter_indexes(table) {
-        let Some(accessor_name) = idx.accessor_name.as_ref() else {
+        let Some(accessor_name) = idx.codegen_name.as_ref() else {
             continue;
         };
         // Whatever the index algorithm on the host,