Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Unable to inherit 'SqlScriptGenerator' class

Open
#42 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp, sql
Domain
databases

Research direction

Start with the SqlScriptGenerator, SqlScriptGeneratorVisitor, ScriptWriter, and Sql100ScriptGenerator signatures shown in the issue. Review how the visitor and writer are currently constructed, then determine the public/protected API changes needed for an external subclass to compile. Done means a custom SqlScriptGenerator can inherit and override the visitor factory without relying on internal types.

Written by the indexing model from the issue text.

Description

enhancement

Is your feature request related to a problem? Please describe.

Consider the following code to inherit SqlScriptGenerator

internal class CustomSqlScriptGenerator : SqlScriptGenerator
{
	public CustomSqlScriptGenerator(SqlScriptGeneratorOptions options) : base(options)
	{
	}

	internal override SqlScriptGeneratorVisitor CreateSqlScriptGeneratorVisitor(SqlScriptGeneratorOptions options, ScriptWriter scriptWriter)
	{
		throw new NotImplementedException();
	}
}

However, this will get compilation error because SqlScriptGeneratorVisitor and ScriptWriter are marked as internal, which is impossible to inherit this class.

Describe the solution you'd like

  • Change CreateSqlScriptGeneratorVisitor(...) become protected instead of internal
  • Remove ScriptWriter parameter in CreateSqlScriptGeneratorVisitor(...). This can avoid to mark ScriptWriter as public. Instantiation of ScriptWriter will be handled by child class of SqlScriptGenerator. See example below.
  • Mark SqlScriptGeneratorVisitor as public accessible. SqlScriptGeneratorVisitor will be used to visit the expression tree when generating TSQL script.

Here is the suggested changes:

protected abstract SqlScriptGeneratorVisitor CreateSqlScriptGeneratorVisitor(SqlScriptGeneratorOptions options);

And update Sql###ScriptGenerator become

Example:

public sealed class Sql100ScriptGenerator : SqlScriptGenerator
{
    public Sql100ScriptGenerator()
        : this(new SqlScriptGeneratorOptions())
    {
    }

    public Sql100ScriptGenerator(SqlScriptGeneratorOptions options)
        : base(options)
    {
    }

    protected override SqlScriptGeneratorVisitor CreateSqlScriptGeneratorVisitor(SqlScriptGeneratorOptions options)
    {
        // Create instance of ScriptWriter. 
        //Currently this is created by private function in SqlScriptGenerator
        ScriptWriter scriptWriter = new ScriptWriter(options);

        ScriptGeneratorSupporter.CheckForNullReference((object) options, nameof (options));
        ScriptGeneratorSupporter.CheckForNullReference((object) scriptWriter, nameof (scriptWriter));
        return (SqlScriptGeneratorVisitor) new Sql100ScriptGeneratorVisitor(options, scriptWriter);
    }
}
Dominant language
GAP
Stars
277
Forks
43
Avg merge
6d 17h
Merged PRs (30d)
3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from microsoft/SqlScriptDOM

All issues in microsoft/SqlScriptDOM

Similar issues

More Databases issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.