DISTKEY and SORTKEY should be in quotations

[solackerman]

Redshift column names can contain spaces. A column name like Foo Bar will become a sql statement looking like this

SORTKEY (Foo Bar)

which will fail. This PR quotify's DISTKEY and SORTKEY, so they will appear like this:

SORTKEY ("Foo Bar")

[graingert]

@solackerman can you create a model + reflection tests with a column name with spaces in?
eg:

class SortKeyDistKeyWithSpaces(Base):
    __tablename__ = 'sort_key_with_spaces'
    col1 = sa.Column('col with spaces', sa.Integer(), primary_key=True)
    __table_args__ = {
        'redshift_diststyle': 'EVEN',
        'redshift_sortkey': 'col with spaces',
        'redshift_distkey': 'col with spaces',
    }

[solackerman]

done.

[graingert]

@jklukas any thoughts?

[jklukas]

I think we can have our cake and eat it too. SQLAlchemy's IdentifierPreparer.quote method exists to conditionally quote identifiers. I think we should use that here rather than putting in explicit quotes. It would be safer (there might be some edge cases we aren't considering if column names contain quotes themselves) and it means quotes aren't added to identifiers unless necessary, which would make output more natural.

So I think we could use something like:

sortkey_string = ", ".join(self.preparer.quote(key) for key in keys)
text += " SORTKEY ({0})".format(sortkey_string)

[jklukas]

Thanks for finding this bug and putting together the PR, @solackerman. Would you agree that conditional quoting is the way to go?

[solackerman]

Totally agree, that's much more elegant. I'll update the PR shortly.

[solackerman]

done.

[jklukas]

This looks great! +1

[graingert]

Is there any chance of this being a breaking change?

[graingert]

Might be worth documenting the fact you can no longer include two columns in one string in the sortkey

[jklukas]

I'd agree that this is a breaking change that should be included in the CHANGES.rst

[jklukas]

@graingert - Do you want to give a final +1 before we merge?

I just remembered that we should probably have a note in the changelog about this as well. We should probably have a CONTRIBUTING.md to write a checklist for PRs.

[graingert]

👍

[graingert]

@solackerman can you update the CHANGELOG because this is a breaking change.

[solackerman]

Done.

[jklukas]

+1

[graingert]

@solackerman can you squash these together into one, please.

[solackerman]

done.

[solackerman]

will there be a new release coming soon?

[graingert]

@solackerman 0.5.0 is out now

[solackerman]

Amazing! Thanks :)