EDUCBA

EDUCBA

MENUMENU
  • Free Tutorials
  • Free Courses
  • Certification Courses
  • 360+ Courses All in One Bundle
  • Login
Home Data Science Data Science Tutorials PostgreSQL Tutorial PostgreSQL Formatter
Secondary Sidebar
PostgreSQL Tutorial
  • Basic
    • What is PostgreSQL
    • PostgreSQL Features
    • How to Install PostgreSQL
    • PostgreSQL Versions
    • PostgreSQL Architecture
    • PostgreSQL GUI
    • Postgres Command-Line
    • PostgreSQL Variables
    • PostgreSQL Data Types
    • PostgreSQL NOT NULL
    • PostgreSQL Integer
    • PostgreSQL Boolean
    • PostgreSQL BIGINT
    • PostgreSQL NULLIF
    • PostgreSQL Administration
    • PostgreSQL Commands
    • PostgreSQL Operators
    • PostgreSQL IN Operator
    • Postgres like query
    • PostgreSQL encode
    • PostgreSQL Cheat Sheet
    • PostgreSQL List Databases
    • PostgreSQL Rename Database
  • Control Statement
    • PostgreSQL IF Statement
    • PostgreSQL if else
    • PostgreSQL CASE Statement
    • PostgreSQL LOOP
    • PostgreSQL For Loop
    • PostgreSQL While Loop
  • Joins
    • Joins in PostgreSQL
    • PostgreSQL Inner Join
    • PostgreSQL Outer Join
    • LEFT OUTER JOIN in PostgreSQL
    • PostgreSQL FULL OUTER JOIN
    • PostgreSQL LEFT JOIN
    • PostgreSQL Full Join
    • PostgreSQL Cross Join
    • PostgreSQL NATURAL JOIN
    • PostgreSQL UPDATE JOIN
  • Queries
    • PostgreSQL Queries
    • PostgreSQL INSERT INTO
    • PostgreSQL WHERE Clause
    • PostgreSQL WITH Clause
    • PostgreSQL ORDER BY
    • PostgreSQL ORDER BY Random
    • PostgreSQL ORDER BY DESC
    • PostgreSQL GROUP BY
    • PostgreSQL group_concat
    • PostgreSQL HAVING
    • PostgreSQL Recursive Query
  • Advanced
    • PostgreSQL Schema
    • Postgres List Schemas
    • PostgreSQL Drop Schema
    • PostgreSQL VARCHAR
    • Array in PostgreSQL
    • PostgreSQL DDL
    • PostgreSQL List Users
    • Postgres Default User
    • Postgres add user
    • PostgreSQL User Password
    • PostgreSQL log_statement
    • PostgreSQL repository
    • PostgreSQL shared_buffer
    • PostgreSQL String Functions
    • PostgreSQL Compare Strings
    • PostgreSQL Text Search
    • PostgreSQL TEXT
    • PostgreSQL String Array
    • PostgreSQL where in array
    • PostgreSQL Constraints
    • PostgreSQL UNIQUE Constraint
    • PostgreSQL CHECK Constraint
    • PostgreSQL INTERSECT
    • PostgreSQL Like
    • Cursors in PostgreSQL
    • PostgreSQL UNION ALL
    • Indexes in PostgreSQL
    • PostgreSQL Index Types
    • PostgreSQL REINDEX
    • PostgreSQL UNIQUE Index
    • PostgreSQL Clustered Index
    • PostgreSQL DROP INDEX
    • PostgreSQL DISTINCT
    • PostgreSQL FETCH
    • PostgreSQL RAISE EXCEPTION
    • PostgreSQL Auto Increment
    • Sequence in PostgreSQL
    • Wildcards in PostgreSQL
    • PostgreSQL Subquery
    • PostgreSQL Alias
    • PostgreSQL LIMIT
    • PostgreSQL Limit Offset
    • PostgreSQL LAG()
    • PostgreSQL Table
    • Postgres Show Tables
    • PostgreSQL Describe Table
    • PostgreSQL Lock Table
    • PostgreSQL ALTER TABLE
    • Postgres Rename Table
    • PostgreSQL List Tables
    • PostgreSQL TRUNCATE TABLE
    • PostgreSQL Table Partitioning
    • Postgres DROP Table
    • PostgreSQL Functions
    • PostgreSQL Math Functions
    • PostgreSQL Window Functions
    • Aggregate Functions in PostgreSQL
    • PostgreSQL Primary Key
    • Foreign Key in PostgreSQL
    • PostgreSQL Procedures
    • PostgreSQL Stored Procedures
    • PostgreSQL Views
    • PostgreSQL Materialized Views
    • Postgres Create View
    • PostgreSQL Triggers
    • PostgreSQL DROP TRIGGER
    • PostgreSQL Date Functions
    • PostgreSQL TO_DATE()
    • PostgreSQL datediff
    • PostgreSQL Timestamp
    • PostgreSQL CURRENT_TIMESTAMP()
    • PostgreSQL Notify
    • PostgreSQL LENGTH()
    • PostgreSQL blob
    • PostgreSQL Median
    • PostgreSQL kill query
    • PostgreSQL Formatter
    • PostgreSQL RANK()
    • PostgreSQL Select
    • PostgreSQL Average
    • PostgreSQL DATE_PART()
    • PostgreSQL EXECUTE
    • PostgreSQL COALESCE
    • PostgreSQL EXTRACT()
    • PostgreSQL Sort
    • PostgreSQL TO_CHAR
    • PostgreSQL Interval
    • PostgreSQL Number Types
    • PostgreSQL ROW_NUMBER
    • Alter Column in PostgreSQL
    • PostgreSQL Identity Column
    • PostgreSQL SPLIT_PART()
    • PostgreSQL CONCAT()
    • PostgreSQL replace
    • PostgreSQL TRIM()
    • PostgreSQL MAX
    • PostgreSQL DELETE
    • PostgreSQL Float
    • PostgreSQL OID
    • PostgreSQL log
    • PostgreSQL REGEXP_MATCHES()
    • PostgreSQL MD5 
    • PostgreSQL NOW()
    • PostgreSQL RANDOM
    • PostgreSQL round
    • PostgreSQL Trunc()
    • PostgreSQL TIME
    • PostgreSQL IS NULL
    • PostgreSQL CURRENT_TIME
    • PostgreSQL MOD()
    • Postgresql Count
    • PostgreSQL Datetime
    • PostgreSQL MIN()
    • PostgreSQL age()
    • PostgreSQL enum
    • PostgreSQL OR
    • PostgreSQL Wal
    • PostgreSQL NOT IN
    • PostgreSQL SET
    • PostgreSQL Current Date
    • PostgreSQL Compare Date
    • PostgreSQL SERIAL
    • PostgreSQL UUID
    • PostgreSQL Merge
    • PostgreSQL Database
    • PostgreSQL Clone Database
    • PostgreSQL Copy Database
    • PostgreSQL Show Databases
    • PostgreSQL Restore Database
    • PostgreSQL DROP DATABASE
    • PostgreSQL ALTER DATABASE
    • Postgres DROP Database
    • Postgres Dump Database
    • PostgreSQL OFFSET
    • PostgreSQL GRANT
    • PostgreSQL COMMIT
    • PostgreSQL ROLLUP
    • PostgreSQL JSON
    • EXPLAIN ANALYZE in PostgreSQL
    • PostgreSQL Temporary Table
    • PostgreSQL Show Tables
    • PostgreSQL cluster
    • PostgreSQL Replication
    • PostgreSQL Logical Replication
    • PostgreSQL flush privileges
    • PostgreSQL Tablespaces
    • CAST in PostgreSQL
    • PostgreSQL CTE
    • hstore in PostgreSQL
    • PostgreSQL Encryption
    • PostgreSQL DECODE()
    • PostgreSQL Vacuum
    • PostgreSQL EXCLUDE
    • Postgres Change Password
    • Postgres Delete Cascade
    • PostgreSQL EXCEPT
    • PostgreSQL Roles
    • PostgreSQL Link
    • PostgreSQL Partition
    • PostgreSQL column does not exist
    • PostgreSQL Log Queries
    • PostgreSQL escape single quote
    • PostgreSQL Query Optimization
    • PostgreSQL Character Varying
    • PostgreSQL Transaction
    • PostgreSQL Extensions
    • PostgreSQL Import CSV
    • PostgreSQL Client
    • PostgreSQL caching
    • PostgreSQL Incremental Backup
    • PostgreSQL JSON vs JSONNB
    • PostgreSQL JDBC Driver
    • PostgreSQL Interview Questions

PostgreSQL Formatter

By Sohel SayyadSohel Sayyad

PostgreSQL Formatter

Definition of PostgreSQL Formatter

PostgreSQL provides a formatter facility to the user. The PostgreSQL formatter works as a console formatter; it will automatically detect the simple environment of a PostgreSQL statement as an output in a text file or HTML file. The most important function of PostgreSQL formatter is that it gives a suitable representation of PostgreSQL statements that means it avoids complexity in a statement. It gives a well-formatted PostgreSQL statement which can be easily understood. The PostgreSQL formatter provides different options for execution such as anonymization, comma- start, comma- break, wrap- comments, debug and comma end, etc.

How does PostgreSQL Formatter Works?

  • We must install a pg formatter in your system.
  • We required basic knowledge about PostgreSQL.
  • We require a query statement to perform the formatter.
  • We need basic knowledge about the pg formatter that means how it is used.
  • We can perform different operations on sql statements with the help of pg formatter.

Examples of PostgreSQL Formatter

Let’s see a different example of PGformatter with different options as follows.

Example #1 – Indentation

Statement:

CREATE TABLE employee ( user_id serial PRIMARY KEY, empname VARCHAR ( 50 )  NOT NULL,      empaddress VARCHAR ( 50 ) NOT NULL, email VARCHAR ( 255 ) UNIQUE NOT NULL);

Start Your Free Data Science Course

Hadoop, Data Science, Statistics & others

Explanation

In the above example, we try to implement indention in the query statement. In this example, we create a table name as an employee with different attributes as shown in sql statement after applying the indentation option we Illustrate the end result of the above declaration by using the use of the following statement.

CREATE TABLE employee (user_id serial PRIMARY KEY,
empname VARCHAR (50) NOT NULL,
empaddress VARCHAR (50) NOT NULL,
email VARCHAR (255) UNIQUE NOT NULL);

Let see how we can format the query by using pgformatter this example for select and from with option -W.

Statement:

SELECT x, y, z, a FROM n_1, n_2, n_3 WHERE x = 20 AND y = 20;

All in One Data Science Bundle(360+ Courses, 50+ projects)
Python TutorialMachine LearningAWSArtificial Intelligence
TableauR ProgrammingPowerBIDeep Learning
Price
View Courses
360+ Online Courses | 50+ projects | 1500+ Hours | Verifiable Certificates | Lifetime Access
4.7 (86,527 ratings)

Explanation: In the above example, we try to implement pgformatter with select and where clause in this example we use some variable with a select clause such as x, y, z, and a and similarly we use n_1, n_2, and n_3 with from clause as well as we also assign values to variable x and y. in this example we wrap option wrap query to a specific length. Indentation is not used to count the character. We show the end result of the above statement in the following snapshot.

PostgreSQL Formatter-1.1

Similarly, we can implement other options as follows.

  • Option –C: In this option, we wrap the comments at the specified length by –W. Indentation is including in the wrap of comments.
  • Option –t: Option –t means format type of query In this option we add a new line in the statement.
  • Option –g: In this option pgformatter groups all statements within the transaction. For more details see the below example.

Example #2

BEGIN;
INSERT INTO demo VALUES (3, 'sample 1');
INSERT INTO demo VALUES (4, 'sample 2');
...
COMMIT;

Explanation: In this example, we try to implement an option –g in pgformatter in the above example we simple transaction the transaction should start with BEGIN and end with COMMIT between these transactions we use different statements as shown in the example. So when we execute option –g at that time it includes a new line between each statement. We show the end result of the above statement in the following snapshot.

PostgreSQL Formatter-1.2

  • Option –L: Option –L means no extra line in pgformatter always adds a new line after the end of the statement when ‘; ‘( semicolon) is present and suppose the user does not require the extra line in the output console then you can remove new line by using this option in the command line.
  • Option –extra-function: In the above option, the user is able to format PostgreSQL internal functions but it cannot detect user-defined functions in PostgreSQL. One possible way is that it can define a single function name per line or we say that list of functions into a file and it gives through the pg formatter –an extra-function option that will be formatter as PostgreSQL internal functions.
  • HINTS: Sometimes pgformatter does not fulfill user needs so at that time we can change the behavior of pg_format by using the configuration file instead of reusing the command line options. By default, pgformatter have a ~/.pg_format but you can select another alternate configuration file by using command line option –c | –config
  • Formatting by using stdin: You are able to execute pg_format without any argument or we can say that you can execute statements by using stdin. The stdin is an interactive mode of pgformatter in which you should type compulsory ctrl+d at the end of the statement.

Example #3

$ pg_format
select * from emp;
<ctrl+d>

We can also use stdin in one line as follows

echo "select * from emp;" | pg_format

  • Formatting by using VI: In this type of pgformatter it automatically formats the statement by changing the configuration file.
  • Formatting by using Atom: If some user uses atom as an editor we need to install pg_formatter with node.js wrapper packages. The main feature of the Atom is that it formats all SQL files in save mode.
  • Formatting by using Visual Studio: Visual Studio Code also provides a pg_formatter extension to format PostgreSQL statements.
  • To prevent replacing the small code: Sometimes users need to maintain the same query statement format without change in the query. At that time we use the –p or –placeholder option in the command line to keep code untouched by pgformatter.

Uses of PostgreSQL Formatter

  • It gives a suitable representation of the query
  • It avoids the complexity of query statements.
  • As per user need, we use different options in the command
  • We can use pg_formatter with different editor tools that means as per our choice we can use any tool to format query statements.

Conclusion

We hope from this article you have understood about the PostgreSQL pg_formatter. From the above article, we have learned the basic example of pg_formatter. We have also learned how we can implement them with different options in PostgreSQL. From this article, we have learned how we can handle PostgreSQL pg_formatter.

Recommended Articles

This is a guide to PostgreSQL Formatter. Here we also discuss the definition and how does postgresql formatter works? along with different examples and its code implementation. You may also have a look at the following articles to learn more –

  1. PostgreSQL ALTER DATABASE
  2. PostgreSQL vs SQLite
  3. PostgreSQL Replication
  4. PostgreSQL vs SQLite
Popular Course in this category
PostgreSQL Course (2 Courses, 1 Project)
  2 Online Courses |  1 Hands-on Project |  7+ Hours |  Verifiable Certificate of Completion
4.5
Price

View Course
0 Shares
Share
Tweet
Share
Primary Sidebar
Footer
About Us
  • Blog
  • Who is EDUCBA?
  • Sign Up
  • Live Classes
  • Corporate Training
  • Certificate from Top Institutions
  • Contact Us
  • Verifiable Certificate
  • Reviews
  • Terms and Conditions
  • Privacy Policy
  •  
Apps
  • iPhone & iPad
  • Android
Resources
  • Free Courses
  • Database Management
  • Machine Learning
  • All Tutorials
Certification Courses
  • All Courses
  • Data Science Course - All in One Bundle
  • Machine Learning Course
  • Hadoop Certification Training
  • Cloud Computing Training Course
  • R Programming Course
  • AWS Training Course
  • SAS Training Course

ISO 10004:2018 & ISO 9001:2015 Certified

© 2022 - EDUCBA. ALL RIGHTS RESERVED. THE CERTIFICATION NAMES ARE THE TRADEMARKS OF THEIR RESPECTIVE OWNERS.

EDUCBA
Free Data Science Course

SPSS, Data visualization with Python, Matplotlib Library, Seaborn Package

*Please provide your correct email id. Login details for this Free course will be emailed to you

By signing up, you agree to our Terms of Use and Privacy Policy.

EDUCBA Login

Forgot Password?

By signing up, you agree to our Terms of Use and Privacy Policy.

EDUCBA
Free Data Science Course

Hadoop, Data Science, Statistics & others

*Please provide your correct email id. Login details for this Free course will be emailed to you

By signing up, you agree to our Terms of Use and Privacy Policy.

EDUCBA

*Please provide your correct email id. Login details for this Free course will be emailed to you

By signing up, you agree to our Terms of Use and Privacy Policy.

Let’s Get Started

By signing up, you agree to our Terms of Use and Privacy Policy.

This website or its third-party tools use cookies, which are necessary to its functioning and required to achieve the purposes illustrated in the cookie policy. By closing this banner, scrolling this page, clicking a link or continuing to browse otherwise, you agree to our Privacy Policy

Loading . . .
Quiz
Question:

Answer:

Quiz Result
Total QuestionsCorrect AnswersWrong AnswersPercentage

Explore 1000+ varieties of Mock tests View more