Function getFunctionComments

backend/plugin/db/oracle/sync.go:1447–1495

getFunctionComments gets comments for functions and procedures from Oracle system views

(txn *sql.Tx, schemaName string)

// getFunctionComments gets comments for functions and procedures from Oracle system views
func getFunctionComments(txn *sql.Tx, schemaName string) (map[db.TableKey]string, error) {
	functionCommentMap := make(map[db.TableKey]string)

	// Oracle stores function/procedure comments in ALL_OBJECTS or USER_OBJECTS
	// However, Oracle doesn't have a standard system view for function/procedure comments
	// We can try to get them from ALL_TAB_COMMENTS where TABLE_TYPE might be 'FUNCTION' or 'PROCEDURE'
	query := ""
	if schemaName == "" {
		query = fmt.Sprintf(`
		SELECT OWNER, TABLE_NAME, COMMENTS
		FROM all_tab_comments
		WHERE OWNER NOT IN (%s) AND OWNER NOT LIKE 'APEX_%%' AND COMMENTS IS NOT NULL
		AND TABLE_TYPE IN ('FUNCTION', 'PROCEDURE')
		ORDER BY OWNER, TABLE_NAME`, systemSchema)
	} else {
		query = fmt.Sprintf(`
		SELECT OWNER, TABLE_NAME, COMMENTS
		FROM all_tab_comments
		WHERE OWNER = '%s' AND COMMENTS IS NOT NULL
		AND TABLE_TYPE IN ('FUNCTION', 'PROCEDURE')
		ORDER BY TABLE_NAME`, schemaName)
	}

	slog.Debug("running get function comments query")
	rows, err := txn.Query(query)
	if err != nil {
		// If the query fails (e.g., TABLE_TYPE for functions not supported), return empty map
		slog.Debug("function comments query failed, returning empty map", slog.String("error", err.Error()))
		return functionCommentMap, nil
	}
	defer rows.Close()

	for rows.Next() {
		var schemaName, functionName, comment string
		if err := rows.Scan(&schemaName, &functionName, &comment); err != nil {
			return nil, err
		}
		key := db.TableKey{Schema: schemaName, Table: functionName}
		functionCommentMap[key] = common.SanitizeUTF8String(comment)
	}
	if err := rows.Err(); err != nil {
		return nil, util.FormatErrorWithQuery(err, query)
	}
	if err := rows.Close(); err != nil {
		return nil, errors.Wrapf(err, "failed to close rows")
	}

	return functionCommentMap, nil
}

// getIndexComments gets comments for indexes from Oracle system views
func getIndexComments(_ *sql.Tx, schemaName string) (map[db.IndexKey]string, error) {