chore: add setting for table ref (#19234)

* add setting for table ref

* fix

Author: zhyass

src/query/ee/src/table_ref/handler.rs

@@ -40,6 +40,16 @@ impl TableRefHandler for RealTableRefHandler {
         ctx: Arc<dyn TableContext>,
         plan: &CreateTableRefPlan,
     ) -> Result<()> {
+        if !ctx
+            .get_settings()
+            .get_enable_experimental_table_ref()
+            .unwrap_or_default()
+        {
+            return Err(ErrorCode::Unimplemented(
+                "Table ref is an experimental feature, `set enable_experimental_table_ref=1` to use this feature",
+            ));
+        }
+
         let tenant = ctx.get_tenant();
         let catalog = ctx.get_catalog(&plan.catalog).await?;
 

src/query/service/src/sessions/query_ctx.rs

@@ -538,6 +538,15 @@ impl QueryContext {
         };
 
         let table = if let Some(branch) = branch {
+            if !self
+                .get_settings()
+                .get_enable_experimental_table_ref()
+                .unwrap_or_default()
+            {
+                return Err(ErrorCode::Unimplemented(
+                    "Table ref is an experimental feature, `set enable_experimental_table_ref=1` to use this feature",
+                ));
+            }
             table.with_branch(branch)?
         } else {
             table

src/query/settings/src/settings_default.rs

@@ -1507,6 +1507,13 @@ impl DefaultSettings {
                     scope: SettingScope::Both,
                     range: Some(SettingRange::Numeric(0..=16)),
                 }),
+                ("enable_experimental_table_ref", DefaultSettingValue {
+                    value: UserSettingValue::UInt64(0),
+                    desc: "experiment setting enable table ref(disable by default).",
+                    mode: SettingMode::Both,
+                    scope: SettingScope::Both,
+                    range: Some(SettingRange::Numeric(0..=1)),
+                }),
             ]);
 
             Ok(Arc::new(DefaultSettings {

src/query/settings/src/settings_getter_setter.rs

@@ -1139,4 +1139,8 @@ impl Settings {
     pub fn get_max_aggregate_spill_level(&self) -> Result<u64> {
         self.try_get_u64("max_aggregate_spill_level")
     }
+
+    pub fn get_enable_experimental_table_ref(&self) -> Result<bool> {
+        Ok(self.try_get_u64("enable_experimental_table_ref")? != 0)
+    }
 }

tests/sqllogictests/suites/ee/08_table_ref/08_0000_branch.test

@@ -12,6 +12,9 @@
 ## See the License for the specific language governing permissions and
 ## limitations under the License.
 
+statement ok
+set enable_experimental_table_ref=1;
+
 statement ok
 DROP DATABASE IF EXISTS test_branch
 

tests/sqllogictests/suites/ee/08_table_ref/08_0001_tag.test

@@ -12,6 +12,9 @@
 ## See the License for the specific language governing permissions and
 ## limitations under the License.
 
+statement ok
+set enable_experimental_table_ref=1;
+
 statement ok
 DROP DATABASE IF EXISTS test_tag
 

tests/sqllogictests/suites/mode/standalone/ee/explain_table_ref.test

@@ -12,6 +12,9 @@
 ## See the License for the specific language governing permissions and
 ## limitations under the License.
 
+statement ok
+set enable_experimental_table_ref=1;
+
 statement ok
 CREATE OR REPLACE DATABASE test_table_ref;
 

tests/suites/5_ee/01_vacuum/01_006_vacuum_table_with_refs.result

@@ -15,7 +15,7 @@ after vacuum
 4
 4
 2
->>>> select c from test_vacuum_orphan_refs.a/b order by c
+>>>> set enable_experimental_table_ref=1; select c from test_vacuum_orphan_refs.a/b order by c
 1
 2
 after add pure orphan files

tests/suites/5_ee/01_vacuum/01_006_vacuum_table_with_refs.sh

@@ -14,7 +14,7 @@ stmt "insert into test_vacuum_orphan_refs.a values (2),(3)"
 stmt "optimize table test_vacuum_orphan_refs.a compact"
 
 FST_SNAPSHOT_ID=$(echo "select snapshot_id from fuse_snapshot('test_vacuum_orphan_refs','a') where row_count=2" | $BENDSQL_CLIENT_CONNECT)
-echo "alter table test_vacuum_orphan_refs.a create branch b at(snapshot => '$FST_SNAPSHOT_ID')" | $BENDSQL_CLIENT_CONNECT
+echo "set enable_experimental_table_ref=1; alter table test_vacuum_orphan_refs.a create branch b at(snapshot => '$FST_SNAPSHOT_ID')" | $BENDSQL_CLIENT_CONNECT
 
 SNAPSHOT_LOCATION=$(echo "select snapshot_location from fuse_snapshot('test_vacuum_orphan_refs','a') limit 1" | $BENDSQL_CLIENT_CONNECT)
 PREFIX=$(echo "$SNAPSHOT_LOCATION" | cut -d'/' -f1-2)
@@ -35,7 +35,7 @@ ls -l /tmp/test_vacuum_orphan_refs/"$PREFIX"/_sg/ | wc -l
 ls -l /tmp/test_vacuum_orphan_refs/"$PREFIX"/_i_b_v2/ | wc -l
 ls -l /tmp/test_vacuum_orphan_refs/"$PREFIX"/_ref/ | wc -l
 
-stmt "select c from test_vacuum_orphan_refs.a/b order by c"
+stmt "set enable_experimental_table_ref=1; select c from test_vacuum_orphan_refs.a/b order by c"
 
 # simulates orphans
 mkdir -p /tmp/test_vacuum_orphan_refs/"$PREFIX"/_ref/1/