feat(query): support show sequences and desc sequence (#17968)

Author: TCeason

src/meta/api/src/schema_api_test_suite.rs

@@ -5786,6 +5786,23 @@ impl SchemaApiTestSuite {
             assert_eq!(resp.current, 1);
         }
 
+        info!("--- list sequence");
+        {
+            let req = CreateSequenceReq {
+                create_option: CreateOption::Create,
+                ident: SequenceIdent::new(&tenant, "seq1"),
+                create_on,
+                comment: Some("seq1".to_string()),
+            };
+
+            let seqs = ["seq", "seq1"];
+            let _resp = mt.create_sequence(req).await?;
+            let values = mt.list_sequences(&tenant).await?;
+            for (i, (name, _)) in values.iter().enumerate() {
+                assert_eq!(name, seqs[i]);
+            }
+        }
+
         info!("--- get sequence nextval");
         {
             let req = GetSequenceNextValueReq {

src/meta/api/src/sequence_api.rs

@@ -20,6 +20,7 @@ use databend_common_meta_app::schema::GetSequenceNextValueReply;
 use databend_common_meta_app::schema::GetSequenceNextValueReq;
 use databend_common_meta_app::schema::SequenceIdent;
 use databend_common_meta_app::schema::SequenceMeta;
+use databend_common_meta_app::tenant::Tenant;
 use databend_common_meta_types::MetaError;
 use databend_common_meta_types::SeqV;
 
@@ -37,6 +38,11 @@ pub trait SequenceApi: Send + Sync {
         req: &SequenceIdent,
     ) -> Result<Option<SeqV<SequenceMeta>>, MetaError>;
 
+    async fn list_sequences(
+        &self,
+        tenant: &Tenant,
+    ) -> Result<Vec<(String, SequenceMeta)>, MetaError>;
+
     async fn get_sequence_next_value(
         &self,
         req: GetSequenceNextValueReq,

src/meta/api/src/sequence_api_impl.rs

@@ -26,12 +26,15 @@ use databend_common_meta_app::schema::GetSequenceNextValueReply;
 use databend_common_meta_app::schema::GetSequenceNextValueReq;
 use databend_common_meta_app::schema::SequenceIdent;
 use databend_common_meta_app::schema::SequenceMeta;
+use databend_common_meta_app::tenant::Tenant;
 use databend_common_meta_kvapi::kvapi;
+use databend_common_meta_kvapi::kvapi::DirName;
 use databend_common_meta_types::MatchSeq;
 use databend_common_meta_types::MetaError;
 use databend_common_meta_types::SeqV;
 use databend_common_meta_types::TxnRequest;
 use fastrace::func_name;
+use futures::TryStreamExt;
 use log::debug;
 
 use crate::databend_common_meta_types::With;
@@ -92,6 +95,20 @@ impl<KV: kvapi::KVApi<Error = MetaError> + ?Sized> SequenceApi for KV {
         Ok(seq_meta)
     }
 
+    #[logcall::logcall]
+    #[fastrace::trace]
+    async fn list_sequences(
+        &self,
+        tenant: &Tenant,
+    ) -> Result<Vec<(String, SequenceMeta)>, MetaError> {
+        let dir_name = DirName::new(SequenceIdent::new(tenant, "dummy"));
+        self.list_pb(&dir_name)
+            .await?
+            .map_ok(|itm| (itm.key.name().to_string(), itm.seqv.data))
+            .try_collect::<Vec<_>>()
+            .await
+    }
+
     async fn get_sequence_next_value(
         &self,
         req: GetSequenceNextValueReq,

src/meta/app/src/schema/sequence.rs

@@ -17,6 +17,7 @@ use chrono::Utc;
 pub use kvapi_impl::SequenceRsc;
 
 use super::CreateOption;
+use crate::tenant::Tenant;
 use crate::tenant_key::ident::TIdent;
 
 /// Defines the meta-service key for sequence.
@@ -80,6 +81,16 @@ pub struct GetSequenceReply {
     pub meta: SequenceMeta,
 }
 
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct ListSequencesReq {
+    pub tenant: Tenant,
+}
+
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct ListSequencesReply {
+    pub info: Vec<(String, SequenceMeta)>,
+}
+
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct DropSequenceReq {
     pub if_exists: bool,

src/query/ast/src/ast/statements/sequence.rs

@@ -39,7 +39,7 @@ impl Display for CreateSequenceStmt {
         if let CreateOption::CreateIfNotExists = self.create_option {
             write!(f, "IF NOT EXISTS ")?;
         }
-        write!(f, " {}", self.sequence)?;
+        write!(f, "{}", self.sequence)?;
         if let Some(comment) = &self.comment {
             write!(f, " COMMENT = {}", QuotedString(comment, '\''))?;
         }
@@ -59,7 +59,7 @@ impl Display for DropSequenceStmt {
         if self.if_exists {
             write!(f, "IF EXISTS ")?;
         }
-        write!(f, " {}", self.sequence)?;
+        write!(f, "{}", self.sequence)?;
         Ok(())
     }
 }

src/query/ast/src/ast/statements/statement.rs

@@ -368,6 +368,12 @@ pub enum Statement {
     // Sequence
     CreateSequence(CreateSequenceStmt),
     DropSequence(DropSequenceStmt),
+    ShowSequences {
+        show_options: Option<ShowOptions>,
+    },
+    DescSequence {
+        name: Identifier,
+    },
 
     // Set priority for query
     SetPriority {
@@ -504,6 +510,8 @@ impl Statement {
             | Statement::DescribeNotification(..)
             | Statement::ExecuteImmediate(..)
             | Statement::ShowProcedures { .. }
+            | Statement::ShowSequences { .. }
+            | Statement::DescSequence { .. }
             | Statement::DescProcedure(..)
             | Statement::CallProcedure(..)
             | Statement::ShowWarehouses(..)
@@ -1006,6 +1014,15 @@ impl Display for Statement {
             }
             Statement::CreateSequence(stmt) => write!(f, "{stmt}")?,
             Statement::DropSequence(stmt) => write!(f, "{stmt}")?,
+            Statement::ShowSequences { show_options } => {
+                write!(f, "SHOW SEQUENCES")?;
+                if let Some(show_options) = show_options {
+                    write!(f, " {show_options}")?;
+                }
+            }
+            Statement::DescSequence { name } => {
+                write!(f, "DESC SEQUENCE {name}")?;
+            }
             Statement::CreateDynamicTable(stmt) => write!(f, "{stmt}")?,
             Statement::SetPriority {
                 priority,

src/query/ast/src/parser/sequence.rs

@@ -24,12 +24,15 @@ use crate::parser::common::map_res;
 use crate::parser::common::IResult;
 use crate::parser::common::*;
 use crate::parser::input::Input;
+use crate::parser::statement::show_options;
 use crate::parser::token::*;
 
 pub fn sequence(i: Input) -> IResult<Statement> {
     rule!(
-         #create_sequence: "`CREATE [OR REPLACE] SEQUENCE [IF NOT EXISTS] <sequence> [COMMENT = '<string_literal>']`"
-         | #drop_sequence: "`DROP [IF EXISTS] <sequence>`"
+         #create_sequence: "`CREATE [OR REPLACE] SEQUENCE [IF NOT EXISTS] <sequence_name> [COMMENT = '<string_literal>']`"
+         | #drop_sequence: "`DROP [IF EXISTS] <sequence_name>`"
+         | #show_sequences: "`SHOW SEQUENCES [<show_limit>]`"
+         | #desc_sequence: "`DESCRIBE SEQUENCE <sequence_name>`"
     )(i)
 }
 
@@ -65,3 +68,21 @@ fn drop_sequence(i: Input) -> IResult<Statement> {
         },
     )(i)
 }
+
+fn show_sequences(i: Input) -> IResult<Statement> {
+    map_res(
+        rule! {
+            SHOW ~ SEQUENCES ~ #show_options?
+        },
+        |(_, _, show_options)| Ok(Statement::ShowSequences { show_options }),
+    )(i)
+}
+
+fn desc_sequence(i: Input) -> IResult<Statement> {
+    map_res(
+        rule! {
+            ( DESC | DESCRIBE ) ~ SEQUENCE ~ #ident
+        },
+        |(_, _, name)| Ok(Statement::DescSequence { name }),
+    )(i)
+}

src/query/ast/src/parser/statement.rs

@@ -2500,7 +2500,6 @@ pub fn statement_body(i: Input) -> IResult<Statement> {
             ( DESC | DESCRIBE ) ~ PROCEDURE ~ #ident ~ #procedure_type_name
         },
         |(_, _, name, args)| {
-            // TODO: modify to ProcedureIdentify
             Statement::DescProcedure(DescProcedureStmt {
                 name: ProcedureIdentity {
                     name: name.to_string(),

src/query/ast/src/parser/token.rs

@@ -1130,6 +1130,8 @@ pub enum TokenKind {
     UPLOAD,
     #[token("SEQUENCE", ignore(ascii_case))]
     SEQUENCE,
+    #[token("SEQUENCES", ignore(ascii_case))]
+    SEQUENCES,
     #[token("SHARE", ignore(ascii_case))]
     SHARE,
     #[token("SHARES", ignore(ascii_case))]
@@ -1686,6 +1688,7 @@ impl TokenKind {
             | TokenKind::ANY
             | TokenKind::FUNCTION
             | TokenKind::PROCEDURE
+            | TokenKind::SEQUENCE
             | TokenKind::ASC
             | TokenKind::ANTI
             // | TokenKind::ASYMMETRIC

src/query/ast/tests/it/parser.rs

@@ -920,6 +920,10 @@ SELECT * from s;"#,
                 RETURN sum;
             END;
             $$;"#,
+        r#"DROP SEQUENCE IF EXISTS seq"#,
+        r#"CREATE SEQUENCE seq comment='test'"#,
+        r#"DESCRIBE SEQUENCE seq"#,
+        r#"SHOW SEQUENCES LIKE '%seq%'"#,
     ];
 
     for case in cases {