basic rename

yb-voyager/src/queryparser/helpers_protomsg.go

@@ -18,6 +18,7 @@ package queryparser
 import (
 	"strings"
 
+	pg_query "github.com/pganalyze/pg_query_go/v5"
 	log "github.com/sirupsen/logrus"
 	"google.golang.org/protobuf/reflect/protoreflect"
 )
@@ -30,6 +31,10 @@ const (
 	XML_FUNCTIONS_DOC_LINK  = DOCS_LINK_PREFIX + POSTGRESQL_PREFIX + "#xml-functions-is-not-yet-supported"
 )
 
+func GetProtoMessageFromParseTree(parseTree *pg_query.ParseResult) protoreflect.Message {
+	return parseTree.Stmts[0].Stmt.ProtoReflect()
+}
+
 func GetMsgFullName(msg protoreflect.Message) string {
 	return string(msg.Descriptor().FullName())
 }

yb-voyager/src/queryparser/helpers_struct.go

@@ -21,7 +21,6 @@ import (
 
 	pg_query "github.com/pganalyze/pg_query_go/v5"
 	"github.com/samber/lo"
-	"google.golang.org/protobuf/reflect/protoreflect"
 )
 
 func DeparseSelectStmt(selectStmt *pg_query.SelectStmt) (string, error) {
@@ -43,10 +42,6 @@ func DeparseSelectStmt(selectStmt *pg_query.SelectStmt) (string, error) {
 	return "", nil
 }
 
-func GetProtoMessageFromParseTree(parseTree *pg_query.ParseResult) protoreflect.Message {
-	return parseTree.Stmts[0].Stmt.ProtoReflect()
-}
-
 func IsPLPGSQLObject(parseTree *pg_query.ParseResult) bool {
 	// CREATE FUNCTION is same parser NODE for FUNCTION/PROCEDURE
 	_, isPlPgSQLObject := getCreateFuncStmtNode(parseTree)
@@ -289,7 +284,6 @@ func GetFuncParametersTypeNames(parseTree *pg_query.ParseResult) []string {
 	return paramTypeNames
 }
 
-
 func IsDDL(parseTree *pg_query.ParseResult) (bool, error) {
 	ddlParser, err := GetDDLProcessor(parseTree)
 	if err != nil {
@@ -299,4 +293,4 @@ func IsDDL(parseTree *pg_query.ParseResult) (bool, error) {
 	//Considering all the DDLs we have a Processor for as of now.
 	//Not Full-proof as we don't have all DDL types but atleast we will skip all the types we know currently
 	return !ok, nil
-}
+}

yb-voyager/src/queryparser/query_parser.go

@@ -13,6 +13,17 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
+/*
+This package contains all the logic related to parsing a query string, and extracting details out of it.
+We mainly use the pg_query_go library to help with this.
+
+The main functions in this package are:
+1. Use pg_query_go to parse the query string into a ParseResult (i.e. a parseTree)
+2. Traverse and process each protobufMessage node of the ParseTree.
+3. For PLPGSQL, convert the PLPGSQL to JSON; get all the statements out of the PLPGSQL block.
+we can put all the parser related logic (the parsing, the parsing of plpgsql to json, the traversal through the proto messages, the traversal through the nested plpgsql json, adding clauses to statements, etc
+*/
 package queryparser
 
 import (