allow index into ForeignKey

[cmflynn]

No description provided.

[codecov-commenter]

Codecov Report

Merging #989 (5e89c1e) into master (fd77f02) will not change coverage.
The diff coverage is 100.00%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #989   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          200       200           
  Lines        16532     16556   +24     
=========================================
+ Hits         16532     16556   +24     

Impacted Files	Coverage Δ
ormar/fields/foreign_key.py	100.00% <100.00%> (ø)
...sts/test_model_definition/test_model_definition.py	100.00% <100.00%> (ø)

[collerek]

Thanks, seems right to include it! :)

Can you please add test (check underlying sqlalchemy table structure if it has the index set / not set based on this setting - you can check Model.Meta.table for columns settings and table indexes) and docs for it (in fk section)

[cmflynn]

Thanks, seems right to include it! :)

Can you please add test (check underlying sqlalchemy table structure if it has the index set / not set based on this setting - you can check Model.Meta.table for columns settings and table indexes) and docs for it (in fk section)

@collerek I looked through the docs and wasn't sure exactly where/what we should add this for argument. The foreign key section does not actually document any of the kwargs that are curried from ormars fk to sqlalchemys fks. I suppose we could start there? happy to do that, or if you have a more specific suggestion of where this documentation should go I'm happy to add it.

[collerek]

That would be awesome!
Yep the fk section looks like a good candidate for this.

[collerek]

Merged in #1276 as I don't have perms on your fork, thanks!