Skip to content

Commit

Permalink
addind better texts
Browse files Browse the repository at this point in the history
  • Loading branch information
Ckk3 committed Jun 6, 2024
1 parent 217cd61 commit 81a47cd
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/guide/export-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

The `export_schema` management command provided here is specifically designed for use with `strawberry_django`. The [default Strawberry export command](https://strawberry.rocks/docs/guides/schema-export) won't work with `strawberry_django` schemas because `strawberry_django` extends the base functionality of Strawberry to integrate with Django models and queries. This command ensures proper schema export functionality.

The `export_schema` management command allows you to export a GraphQL schema defined using the `strawberry_django` library. This command converts the schema definition to a text format, which can then be saved to a file or printed to the console.
The `export_schema` management command allows you to export a GraphQL schema defined using the `strawberry_django` library. This command converts the schema definition to GraphQL schema definition language (SDL), which can then be saved to a file or printed to the console.

## Usage

To use the `export_schema` command, you need to specify the location of the schema. Optionally, you can provide a file path to save the schema. If no path is provided, the schema will be printed to the console.
To use the `export_schema` command, you need to specify the schema location(e.g., myapp.schema). Optionally, you can provide a file path to save the schema. If no path is provided, the schema will be printed to the console.

```sh
python manage.py export_schema <schema_location> --path <output_path>
```

### Arguments

- `<schema_location>`: The location of the schema module. This should be a dot-separated Python path (e.g., myapp.schema).
- `<schema_location>`: The location of the schema module. This should be a dot-separated Python path (e.g., myapp.schema). For example, if your schema is located in the `schemas` directory in the `myapp` django app, you would use `myapp.schemas`.

### Options

Expand Down

0 comments on commit 81a47cd

Please sign in to comment.