Code refactoring

Last modified: 14 September 2023

Example of the Rename refactoring at youtube.com.

Refactoring is a process of improving your source code without creating a new functionality. Refactoring helps you keep your code solid and easy to maintain.

Rename refactoring

Rename database objects

  1. Place the caret at the object that you want to rename.

  2. Navigate to Refactor | Rename . If you edit an argument in the function, you can start typing a new name inline, or press twice to invoke the Rename dialog.

    If you rename the element inline, you can click icons near the element, and select whether you want to rename it in comments and strings or all the text occurrences.

    rename the element inline

  3. In the Rename dialog, type a new name for the object.

  4. Review changes and click Refactor. To search for usages of the object name, click Preview.

    Rename database objects

Rename code in place

  1. In the editor start renaming a column, a variable, or any other code element. DataGrip will display the Rename the usages of icon in the gutter.

  2. Click the gutter icon or press and apply a suggestion.

    Rename inline

    DataGrip renames the code element and updates its usages accordingly.

    Rename refactoring result

Extract refactorings

Extract a variable

  1. Place the caret at a variable in the function.

  2. Navigate to Refactor | Introduce Variable ().

  3. Select a part of the expression that you want to extract and press .

    https://resources.jetbrains.com.cn/help/img/idea/2023.2/db_refactoring_extract_variable.png
    Gif

Extract as a Common Table Expression (CTE)

CTE is a temporary result set that you can use within another SELECT, INSERT, UPDATE, or DELETE statements. In DataGrip you can extract a subquery and convert it to CTE.

  1. Place the caret inside the subquery that you want to convert.

  2. Go to Refactor | Extract/Introduce | Subquery as CTE.

    https://resources.jetbrains.com.cn/help/img/idea/2023.2/db_refactoring_extract_subquery_as_cte.png
    Gif

Extract queries as a table function

  1. Select a query that you want to extract as a table function.

  2. Right-click a selection and select Refactor | Extract Routine. Alternatively, press .

  3. In the Name field, type the routine's name.

  4. In the Parameters field, select or clear checkboxes for parameters that you want to use.

    https://resources.jetbrains.com.cn/help/img/idea/2023.2/db_extract_queries_as_a_table_function.png
    Gif

Preview refactoring changes

For some refactorings, DataGrip lets you preview the changes before applying them.

  1. Click Preview in the Refactoring Preview dialog to see potential changes (the list of usages where the refactoring will be performed).

  2. In the Find tool window that opens, check the changes that are going to be made. You can exclude or remove changes that you consider unnecessary.

  3. Click Do Refactor to proceed with the changes.

The Preview changes window