Taking control of your queries with GraphQL, Alba Rivas
0 likes2,445 views
This document discusses GraphQL and how it can be used with Salesforce. It provides an overview of what GraphQL is, how it works, and how it compares to REST APIs. It also demonstrates how to use the GraphQL API and wire adapter in Salesforce, including examples of basic queries. Key upcoming milestones in the Salesforce GraphQL roadmap are highlighted.
Taking control of your queries with GraphQL, Alba Rivas
- 1. Taking control of your queries with GraphQL Czech Dreamin ‘23
- 2. OUR SPONSORS
- 3. #CD2023 @CzechDreami n Principal Developer Advocate, Salesforce Twitter: @AlbaSFDC Linkedin: linkedin.com/in/alba-rivas Email: [email protected] Twitch: twitch.tv/albarivas YouTube: youtube.com/c/AlbaRivasSalesforce Alba Rivas
- 4. Forward-Looking Statement Statement under the Private Securities Litigation Reform Act of 1995: This presentation contains forward-looking statements about the company’s financial and operating results, which may include expected GAAP and non-GAAP financial and other operating and non-operating results, including revenue, net income, diluted earnings per share, operating cash flow growth, operating margin improvement, expected revenue growth, expected current remaining performance obligation growth, expected tax rates, the one-time accounting non-cash charge that was incurred in connection with the Salesforce.org combination; stock-based compensation expenses, amortization of purchased intangibles, shares outstanding, market growth and sustainability goals. The achievement or success of the matters covered by such forward-looking statements involves risks, uncertainties and assumptions. If any such risks or uncertainties materialize or if any of the assumptions prove incorrect, the company’s results could differ materially from the results expressed or implied by the forward-looking statements we make. The risks and uncertainties referred to above include -- but are not limited to -- risks associated with the effect of general economic and market conditions; the impact of geopolitical events; the impact of foreign currency exchange rate and interest rate fluctuations on our results; our business strategy and our plan to build our business, including our strategy to be the leading provider of enterprise cloud computing applications and platforms; the pace of change and innovation in enterprise cloud computing services; the seasonal nature of our sales cycles; the competitive nature of the market in which we participate; our international expansion strategy; the demands on our personnel and infrastructure resulting from significant growth in our customer base and operations, including as a result of acquisitions; our service performance and security, including the resources and costs required to avoid unanticipated downtime and prevent, detect and remediate potential security breaches; the expenses associated with new data centers and third-party infrastructure providers; additional data center capacity; real estate and office facilities space; our operating results and cash flows; new services and product features, including any efforts to expand our services beyond the CRM market; our strategy of acquiring or making investments in complementary businesses, joint ventures, services, technologies and intellectual property rights; the performance and fair value of our investments in complementary businesses through our strategic investment portfolio; our ability to realize the benefits from strategic partnerships, joint ventures and investments; the impact of future gains or losses from our strategic investment portfolio, including gains or losses from overall market conditions that may affect the publicly traded companies within the company's strategic investment portfolio; our ability to execute our business plans; our ability to successfully integrate acquired businesses and technologies, including delays related to the integration of Tableau due to regulatory review by the United Kingdom Competition and Markets Authority; our ability to continue to grow unearned revenue and remaining performance obligation; our ability to protect our intellectual property rights; our ability to develop our brands; our reliance on third-party hardware, software and platform providers; our dependency on the development and maintenance of the infrastructure of the Internet; the effect of evolving domestic and foreign government regulations, including those related to the provision of services on the Internet, those related to accessing the Internet, and those addressing data privacy, cross-border data transfers and import and export controls; the valuation of our deferred tax assets and the release of related valuation allowances; the potential availability of additional tax assets in the future; the impact of new accounting pronouncements and tax laws; uncertainties affecting our ability to estimate our tax rate; the impact of expensing stock options and other equity awards; the sufficiency of our capital resources; factors related to our outstanding debt, revolving credit facility, term loan and loan associated with 50 Fremont; compliance with our debt covenants and lease obligations; current and potential litigation involving us; and the impact of climate change. Further information on these and other factors that could affect the company’s financial results is included in the reports on Forms 10-K, 10-Q and 8-K and in other filings it makes with the Securities and Exchange Commission from time to time. These documents are available on the SEC Filings section of the Investor Information section of the company’s website at www.salesforce.com/investor. Salesforce.com, inc. assumes no obligation and does not intend to update these forward-looking statements, except as required by law.
- 5. What’s a GraphQL API? Specification for API Server + Query Language - Facebook 2015 Single endpoint for all the resources, that can be aggregated Requests only the necessary data Schema-driven, enabling introspection Widely adopted through a fast growing community graphql.com
- 6. GraphQL API REST API How does GraphQL work?
- 7. Conference__c Name Attendees__c Country__c Talk__c Name Title__c Abstract__c Conference__c Duration__c Speakers__c PARENT CHILD GraphQL Data Shape A GraphQL server represents data following a schema that has the form of a graph, that can be traversed with: ● Queries ● Mutations - Winter ‘24 ● Subscriptions - not in Salesforce yet
- 8. Basic Query query allConferences { uiapi { query { Conference__c { edges { node { Id Name { value } Country__c { value } } } } } } } Relay Cursor Connections spec Basic Query
- 9. GraphQL API Clients https://{MyDomainName}.my.salesforce.com/services/data/v{version}/graphql Use an API client to test your queries: ● Altair - altairgraphql.dev (access to autogenerated documentation) ● Postman - tinyurl.com/salesforce-postman ● GraphiQL - github.com/graphql/graphiql Need an API access token - get it through Salesforce CLI or connected app + OAuth flow in production
- 11. REST Composite API User Interface API GraphQL API Retrieve data from multiple objects In a single HTTP request Through multiple HTTP requests In a single HTTP request Retrieve data and metadata No Yes Yes Modify data Yes Yes No Send query information Endpoint + JSON Endpoint + JSON Fully in JSON Support in LWC None Through multiple REST wire adapters Through one unique GraphQL wire adapter Documentation & Dev Tooling Not autogenerated Not autogenerated Autogenerated with introspection Community - - + GraphQL vs Other Salesforce APIs
- 12. Where to use GraphQL from?
- 13. GraphQL Wire Adapter (Beta) Enable native querability for LWCs Query Salesforce data using SOQL-like queries with rich predicates Built-in shared caching by LDS Data served from cache if not changed on server and improved app performance Data consistency guarantee Data freshness and consistency across components and wires
- 14. Basic Query GraphQL Wire Adapter (Beta) import { LightningElement, wire } from 'lwc'; import { gql, graphql } from 'lightning/uiGraphQLApi'; export default class ExampleGQL extends LightningElement { @wire(graphql, { query: gql` query AccountInfo { uiapi { query { Account(where: { Name: { like: "United%" } }) @category(name: "recordQuery") { edges { node { Name @category(name: "StringValue") { value displayValue } } } } } } }` }) propertyOrFunction }
- 15. Retrieving Data/Metadata in LWC Apex LDS REST Wire Adapters GraphQL Wire Adapter (Pilot) Retrieve data / metadata for multiple objects In a single HTTP request, but hard In multiple HTTP requests In a single HTTP request Indicate fields to retrieve Yes, but hard In some of them Yes LDS Caching and synchronization (and offline capabilities) No Yes Yes Advanced features: directives, fragments etc. No No Yes
- 16. Winter ‘23 GraphQL API (GA) GraphQL Wire Adapter (Pilot) Mutations Support in API (Pilot) GraphQL Wire Adapter (GA) GraphQL Wire Adapter (Beta) Aggregate query support in API Spring ‘23 Summer ‘23 Winter ‘24 & Beyond Roadmap
- 18. Salesforce Developers @SalesforceDevs developer.salesforce.com Connect with Us Welcome! www.salesforce.com/devcommunity
- 19. Thank you